As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Integração dos produtos do agente de IA com base na API

Diretrizes de produtos do agente de IA com base na API

AWS Marketplace fornece diretrizes para todos os produtos de agentes de IA baseados em API de software como serviço (SaaS). Essas diretrizes garantem uma experiência segura e confiável para os clientes.

Processo de revisão do produto

Quando você envia um produto, AWS Marketplace revisa o produto e seus metadados para verificar se ele atende às diretrizes atuais. Atualizamos regularmente essas diretrizes para atender aos requisitos de segurança em constante evolução.

Manutenção da conformidade

AWS Marketplace monitora continuamente os produtos para verificar a conformidade. Se o produto não atender às diretrizes atuais:

Integração dos produtos do agente de IA com base na API

Integração com base na definição de preço

Integrar seu produto com AWS Marketplace é uma etapa para listar um produto de agente de IA baseado em API. Para integrar seu produto de agente de IA baseado em API AWS Marketplace, você deve escrever código e demonstrar que ele pode responder com sucesso a vários cenários de clientes.

Para obter informações sobre como integrar o produto com base em diferentes modelos de definição de preço, consulte os seguintes tópicos:

Integração de clientes

Redirecionar para o preenchimento do site

Quando os clientes assinam seu produto por meio de AWS Marketplace, eles acessam o produto em seu ambiente da AWS. Depois da assinatura, vamos direcionar o cliente para o site a fim de registrar a conta e configurar o produto.

QuickLaunch cumprimento

Quando os clientes assinam seu produto por meio de AWS Marketplace, eles recebem uma chave de API ou OAuth credenciais para fazer chamadas para seu endpoint de API ou servidor MCP. O processo funciona da seguinte maneira:

Saiba mais sobre QuickLaunch atendimento nos seguintes recursos:

Acessando AWS Marketplace APIs

A seção a seguir descreve o processo de integração com o Serviço de AWS Marketplace Medição ou o Serviço de AWS Marketplace Direitos, usado para garantir que sua cobrança e relatórios sobre o uso de seus produtos pelo cliente sejam precisos.

Notificações do SNS

Assine os tópicos do Amazon Simple Notification Service (Amazon SNS) para receber notificações sobre alterações na assinatura de clientes e direitos contratuais de seus produtos. AWS Marketplace fornece esses tópicos durante a criação do produto para ajudá-lo a gerenciar o acesso do cliente.

Os seguintes tópicos do Amazon SNS estão disponíveis para produtos com base em API de SaaS:

Modelos de instruções de uso

Modelo de instruções de uso do servidor MCP

O exemplo a seguir demonstra instruções de uso de um servidor MCP, inclusive descrições de ferramentas, pré-requisitos, configuração de autenticação, configuração para clientes populares, limites de taxa e recursos adicionais:

To get started using the remove MCP server, follow the instructions below:

**Availble Tools**
This MCP server support the following tools:
- Search - Performs a web search
- Summarize Website - Summarizes a webpage 

**Prerequisites**
- Install **Node.js** and **npm**

**Authentication**
Replace `YOUR_API_KEY` with your actual key below.

**Claude Desktop**
Edit the configuration file at:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the below code:
```
{
  "mcpServers": {
    "demo-example": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://remote.mcp.server/sse",
        "--header",
        "Authorization: Bearer <YOUR_API_KEY>"
      ]
    },
  }
}
```

**Cline**
Cline stores MCP server configurations in a JSON file that can be modified.
In the "Installed" tab, click "Configure MCP Servers" to access the settings file.

Add the following:
```
{
    "mcpServers": {
        "demoServer": {
            "url": "https://remote.mcp.server/sse",
            "disabled": false,
            "autoApprove": ["searchWeb", "summarizeWebsite"],
            "timeout": 30
        }
    }
}
```

**Rate Limits**
- 60 requests per minute per API key.  
- Exceeding returns HTTP 429 Too Many Requests.  
- Use retry and exponential backoff to handle limits.  

**Learn More**
MCP Docs: https://mcp.search.demoproduct.com
            

Modelo de instruções de uso do agente de IA e atendente e ferramentas

O exemplo a seguir demonstra as instruções de uso de um agente ou ferramentas de agente, incluindo pré-requisitos, configuração de autenticação, endpoints compatíveis, request/response esquema, códigos de erro e recursos adicionais:

To get started follow the instructions below:

**Authentication**
All API requests require this HTTP header:
Authorization: Bearer `YOUR_API_KEY`
Replace `YOUR_API_KEY` with your actual key.

**Search Endpoint**

**Endpoint:** `GET /web/search`
Performs a web search.

**Query Parameters:**
| Param | Type | Description |
|------------|--------|-------------------------------------|
| `q` | string | Your search query (required) |
| `count` | int | Number of results (default: 10) |
| `offset` | int | Offset for pagination |
| `country` | string | Country code (e.g. `us`, `de`) |
| `safesearch` | string | `off`, `moderate`, or `strict` |

**Example Request:**
```bash
curl -X GET "https://api.search.demo.com/res/v1/web/search?q=searchtool" \
-H "Authorization: Bearer YOUR_API_KEY"
```
**Response Schema:**  
```  
{
    "results": [{  
            "title": "string",  
            "url": "string",
            "description": "string"  
    }],
    "query" :"string",
    "total" :"number"
}  
```
**Example Response:**
```
{
    "results": [
      {
        "title": "DemoProductAPI",
        "url": "https://demo.com",
        "description": "Demo Product API is a search tool for..."
      }
    ],
    "query": "searchtool",
    "total": 1
}
```

**Additional Search Types**
DemoProduct also supports:
- `GET /news/search – News articles`
- `GET /images/search – Image results`
- `GET /videos/search – Video results`

These endpoints follow the same format as /web/search.

**Summarize Endpoint**
**Endpoint:** `POST /summarize`

Summarizes a webpage 
**Request Headers:**  
Content Type: application/json
**Request Body:**  
```  
{
    "input": "string" // URL or plain text
}    
```
**Example Request:** 
```
{
    "input": "https://example.com/article"
} 
```
**Response Schema**
```
    {
            "summary": "string"  
    }    
```
**Example Response**
``` 
    {
         "summary": "This article explains our commitment to user privacy."
    }   
```

**Error Codes**
| Status | Meaning |
| ------ | ------------------------------ |
| `401` | Unauthorized (check your key) |
| `429` | Too many requests (rate limit) |
| `500` | Server error |

All error responses follow this structure:
```
{
    "error": {
    "code": 401,
    "message": "Unauthorized"
    }
}
```

**Rate Limits**
- 60 requests per minute per API key.  
- Exceeding returns HTTP 429 Too Many Requests.  
- Use retry and exponential backoff to handle limits.  

**Learn More**
API Docs: https://api.search.demoproduct.com