Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Intégration de produits d'agents d' API-based IA
API-based Directives relatives aux produits destinés aux agents IA
AWS Marketplace fournit des directives pour tous les produits d'agent d' API-based IA logiciels en tant que service (SaaS). Ces directives garantissent aux clients une expérience sûre et fiable.
Processus d'évaluation des produits
Lorsque vous soumettez un produit, AWS Marketplace vérifiez le produit et ses métadonnées pour vérifier qu'il est conforme aux directives en vigueur. Nous mettons régulièrement à jour ces directives pour répondre à l'évolution des exigences de sécurité.
Maintien de la conformité
AWS Marketplace surveille en permanence les produits pour vérifier leur conformité. Si votre produit ne répond pas aux directives en vigueur :
-
Il se peut que votre produit ne soit pas disponible pour les nouveaux abonnés jusqu'à ce que vous résolviez les problèmes.
-
Vous devez mettre à jour votre produit pour répondre aux nouvelles exigences
| Catégorie | Consignes |
|---|---|
| Fonctionnalité de l'API et de l'agent | Toutes les API doivent être fonctionnelles et répondre de manière appropriée. Si vous mettez en vente un agent, la solution doit démontrer ses capacités autonomes en fonctionnant sans commandes externes explicites ni interventions humaines constantes. |
| Accès à l'API et authentification | Le client doit être en mesure de s'abonner à votre annonce et de récupérer les clés d'API ou de suivre les étapes pour générer le jeton OAuth. |
| Consignes d'architecture | Suivez les directives d'architecture pour plus de détails. |
| Exigences en matière d'information du client | Suivez les exigences relatives aux informations du client pour plus de détails. |
| Gestion des clés | Les fournisseurs doivent fournir aux clients la possibilité d'accéder aux invalidate/rotate clés. Les fournisseurs devraient également disposer d'un mécanisme permettant d'invalider les clés une fois que le client se désabonne de l'annonce. |
| Configuration requise pour le serveur MCP (le cas échéant) | Pour le serveur MCP, les fournisseurs doivent fournir les détails de configuration du MCP à distance ainsi que les conditions préalables ou les variables d'environnement nécessaires à la configuration. |
| Configuration du produit | Suivez les directives de configuration du produit pour plus de détails. |
| Utilisation du produit | Suivez les directives d'utilisation du produit pour plus de détails. |
| Instructions d'utilisation | Les instructions d'utilisation doivent clairement indiquer les prérequis, la configuration de l'authentification, les points de terminaison pris en charge, le request/response schéma, la description de l'outil, les codes d'erreur et les ressources supplémentaires. |
Intégration de produits d'agents d' API-based IA
Intégration basée sur le prix des produits
L'intégration de votre produit à AWS Marketplace est une étape de la mise en vente d'un produit d'agent API-based AI. Pour intégrer votre produit d'agent API-based AI AWS Marketplace, vous devez écrire du code et démontrer qu'il peut répondre avec succès à plusieurs scénarios clients.
Pour plus d'informations sur l'intégration de votre produit en fonction de différents modèles de tarification, consultez les rubriques suivantes :
-
Pour plus d'informations sur les produits par abonnement, consultez. Intégrer votre abonnement ou Pay-As-You-Go produit SaaS avec AWS Marketplace
-
Pour plus d'informations sur les produits basés sur des contrats, consultez. Intégrer votre produit contractuel SaaS avec AWS Marketplace
-
Pour plus d'informations sur les contrats relatifs aux produits payables à l'utilisation, consultez. Intégrer votre produit SaaS basé sur un contrat avec AWS Marketplace
Intégration des clients
Redirection vers le site Web Fulfillment
Lorsque les clients s'abonnent à votre produit via AWS Marketplace, ils accèdent au produit dans votre environnement AWS. Après leur inscription, nous dirigeons les clients vers le site Web de votre produit pour enregistrer leur compte et configurer le produit.
-
Découvrez comment intégrer des clients à l'aide de Redirect to Website Fulfillment dansIntégrer les clients à votre produit SaaS via AWS Marketplace.
QuickLaunch accomplissement
Lorsque les clients s'abonnent à votre produit via AWS Marketplace, ils reçoivent une clé API ou des informations d'identification OAuth pour appeler votre point de terminaison d'API ou votre serveur MCP. Le processus fonctionne comme suit :
-
Le client s'abonne au produit.
-
Le client s'inscrit ou se connecte à un compte sur votre site Web.
-
Vous utilisez l'PutDeploymentParameterAPI pour stocker la clé d'API ou les informations d'identification OAuth dans le AWS Secrets Manager du client.
Si vous stockez un paramètre dans le cas de clés d'API, appelez l'
PutDeploymentParameterAPI avec lesecretStringparamètre sous forme de chaîne. Si vous stockez plusieurs paramètres dans le cas des informations d'identification OAuth, fournissez une chaîne JSON avec des paires clé-valeur dans lesecretStringparamètre, comme indiqué ci-dessous :{ "Client Id": "12345", "Client Secret": "12345", "Discovery URL" : "https://auth.example.com/.well-known/openid-configuration" }
Pour en savoir plus sur le QuickLaunch traitement des commandes, consultez ces ressources :
-
En savoir plus sur PutDeploymentParameterl'API dans l'API AWS Marketplace de déploiement
-
Trouvez les instructions d'intégration des clients dans Intégrer les clients à votre produit SaaS via AWS Marketplace
Accès AWS Marketplace API
La section suivante décrit le processus d'intégration au service de AWS Marketplace mesure ou au service d' AWS Marketplace admissibilité, utilisé pour garantir l'exactitude de votre facturation et des rapports relatifs à l'utilisation de vos produits par les clients.
-
Pour en savoir plus sur l'accès aux AWS Marketplace API, consultezAccès au service de AWS Marketplace comptage et de gestion des droits APIs.
Notifications SNS
Abonnez-vous aux rubriques Amazon Simple Notification Service (Amazon SNS) pour recevoir des notifications concernant les modifications d'abonnement des clients et les droits contractuels relatifs à vos produits. AWS Marketplace fournit ces rubriques lors de la création du produit pour vous aider à gérer l'accès des clients.
Les rubriques Amazon SNS suivantes sont disponibles pour les produits API-based SaaS :
-
Rubrique Amazon SNS : aws-mp-entitlement-notification— Vous avertit lorsque les clients créent, mettent à niveau ou renouvellent des contrats, ou lorsque les contrats expirent. Ceci n'est disponible que pour les produits dont les modèles de tarification incluent un contrat.
-
Rubrique Amazon SNS : aws-mp-subscription-notification— Vous avertit lorsque des clients s'abonnent ou se désabonnent de votre produit et inclut le drapeau
offer-identifierpour les offres privées et un indicateur d'essai gratuit pour les essais gratuits de SaaS. Ceci est disponible pour tous les modèles de tarification, y compris les contrats et les abonnements.
Modèles d'instructions d'utilisation
Modèle d'instructions d'utilisation du serveur MCP
L'exemple suivant présente les instructions d'utilisation d'un serveur MCP, y compris les descriptions des outils, les prérequis, la configuration de l'authentification, la configuration pour les clients courants, les limites de débit et les ressources supplémentaires :
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, choose "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
Modèle d'instructions d'utilisation de l'agent AI et des & outils d'agent
L'exemple suivant illustre les instructions d'utilisation d'un agent ou de ses outils, notamment les conditions requises, la configuration de l'authentification, les points de terminaison pris en charge, le request/response schéma, les codes d'erreur et les ressources supplémentaires :
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