View a markdown version of this page

Integración de productos de agentes de IA basados en API - AWS Marketplace

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Integración de productos de agentes de IA basados en API

Pautas sobre productos para agentes de IA basados en API

AWS Marketplace proporciona pautas para todos los productos de agentes de IA basados en API de software como servicio (SaaS). Estas pautas garantizan una experiencia segura y fiable para los clientes.

Proceso de revisión de producto

Cuando envíes un producto, AWS Marketplace revisa el producto y sus metadatos para comprobar que cumple con las directrices actuales. Revisamos estas directrices habitualmente para que cumplan nuestros requisitos de seguridad en evolución.

Mantenimiento del cumplimiento

AWS Marketplace supervisa continuamente los productos para verificar su conformidad. Si su producto no cumple con las pautas actuales:

  • Es posible que su producto no esté disponible para los nuevos suscriptores hasta que resuelva los problemas.

  • Debe actualizar el producto para que cumpla con los nuevos requisitos.

Categoría Directrices
Funcionalidad de la API y de los agente Todos ellos APIs deben ser funcionales y responder adecuadamente. Si va a incluir un agente, la solución debe demostrar sus capacidades autónomas y debe funcionar sin comandos externos explícitos ni intervenciones humanas constantes.
Acceso y autenticación de la API El cliente debería poder suscribirse a tu anuncio y recuperar las claves de la API o seguir los pasos para generar el OAuth token.
Pautas relacionadas con la arquitectura Siga las pautas relacionadas con la arquitectura para obtener más información.
Requisitos de información del cliente Siga los requisitos de información del cliente para obtener más información.
Administración de claves Los proveedores deben proporcionar a los clientes la posibilidad de acceder a invalidate/rotate las claves. Los proveedores también deben disponer de un mecanismo para invalidar las claves una vez que el cliente se dé de baja del anuncio.
Requisitos del servidor MCP (si corresponde) En el caso del servidor MCP, los proveedores deben proporcionar los detalles de la configuración del MCP remoto junto con cualquier requisito previo o variable de entorno para la configuración.
Configuración del producto Siga las pautas de configuración del producto para obtener más información.
Uso del producto Siga las pautas de uso del producto para obtener más información.
Instrucciones de uso Las instrucciones de uso deben indicar claramente los requisitos previos, la configuración de la autenticación, los puntos finales compatibles, el request/response esquema, la descripción de la herramienta, los códigos de error y los recursos adicionales.

Integración de productos de agentes de IA basados en API

Integración basada en el precio de los productos

Integrar tu producto AWS Marketplace es un paso para publicar un producto de agente de IA basado en una API. Para integrar tu producto de agente de IA basado en una API AWS Marketplace, debes escribir código y demostrar que puede responder satisfactoriamente a varios escenarios de clientes.

Para obtener más información acerca de cómo integrar su producto según diferentes modelos de precios, consulte los siguientes temas:

Incorporación de clientes

Redirección al sitio web de cumplimiento

Cuando los clientes se suscriben a su producto AWS Marketplace, acceden al producto en su entorno de AWS. Después de suscribirse, dirigimos a los clientes al sitio web de su producto para que registren su cuenta y lo configuren.

QuickLaunch cumplimiento

Cuando los clientes se suscriben a tu producto AWS Marketplace, reciben una clave de API o OAuth credenciales para realizar llamadas a tu terminal de API o servidor MCP. El proceso funciona de la siguiente manera:

  • El cliente se suscribe al producto.

  • El cliente se registra o inicia sesión en una cuenta en su sitio web.

  • La PutDeploymentParameterAPI se utiliza para almacenar la clave o las OAuth credenciales de la API en el AWS Secrets Manager del cliente.

  • Si guarda un parámetro en el caso de las claves de la API, llame a la API PutDeploymentParameter con el parámetro secretString en forma de cadena. Si guardas más de un parámetro en el caso de OAuth las credenciales, proporciona una cadena JSON con pares clave-valor en el secretString parámetro, como se muestra a continuación:

    { "Client Id": "12345", "Client Secret": "12345", "Discovery URL" : "https://auth.example.com/.well-known/openid-configuration" }

Obtén más información sobre la QuickLaunch gestión logística en estos recursos:

Acceder AWS Marketplace APIs

En la siguiente sección se describe el proceso de integración con el servicio de AWS Marketplace medición o el servicio de asignación de AWS Marketplace derechos, que se utiliza para garantizar que la facturación y los informes sobre el uso que los clientes hacen de sus productos sean precisos.

Notificaciones de SNS

Suscríbase a los temas del Amazon Simple Notification Service (Amazon SNS) para recibir notificaciones sobre los cambios de suscripción de los clientes y los derechos contractuales de sus productos. AWS Marketplace proporciona estos temas durante la creación del producto para ayudarle a gestionar el acceso de los clientes.

Los siguientes temas de Amazon SNS están disponible para productos SaaS basados en API:

  • Tema de Amazon SNS: aws-mp-entitlement-notification: le notifica cuando los clientes crean, actualizan o renuevan contratos o cuando los contratos caducan. Solo está disponible para productos con modelos de precios que incluyen un contrato.

  • Tema de Amazon SNS: aws-mp-subscription-notification: le notifica cuando un comprador se suscribe o cancela su suscripción a un producto e incluye el offer-identifier para ofertas privadas y una marca de pruebas gratuitas para las pruebas gratuitas de SaaS. Está disponible para todos los modelos de precios, incluidos los contratos y las suscripciones.

Plantillas de instrucciones de uso

Plantilla de instrucciones de uso del servidor MCP

El siguiente ejemplo muestra las instrucciones de uso de un servidor MCP, incluidas las descripciones de las herramientas, los requisitos previos, la configuración de la autenticación, la configuración para los clientes populares, los límites de velocidad y los recursos adicionales:

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

Plantilla de instrucciones de uso de agentes y herramientas de IA

El siguiente ejemplo muestra las instrucciones de uso de un agente o sus herramientas, incluidos los requisitos previos, la configuración de la autenticación, los puntos finales compatibles, el request/response esquema, los códigos de error y los recursos adicionales:

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