Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Integration von API-basierten KI-Agentenprodukten
Richtlinien für API-basierte Produkte für KI-Agenten
AWS Marketplace bietet Richtlinien für alle AI-Agent-Produkte, die auf Software-as-a-Service (SaaS) -APIs basieren. Diese Richtlinien gewährleisten eine sichere und vertrauenswürdige Erfahrung für Kunden.
Prozess der Produktbewertung
Wenn Sie ein Produkt einreichen, AWS Marketplace überprüft es das Produkt und seine Metadaten, um sicherzustellen, dass es den aktuellen Richtlinien entspricht. Wir aktualisieren diese Richtlinien regelmäßig, um den sich ändernden Sicherheitsanforderungen gerecht zu werden.
Aufrechterhaltung der Einhaltung der Vorschriften
AWS Marketplace überwacht die Produkte kontinuierlich, um die Einhaltung der Vorschriften zu überprüfen. Wenn Ihr Produkt die aktuellen Richtlinien nicht erfüllt:
-
Ihr Produkt ist möglicherweise für neue Abonnenten nicht verfügbar, bis Sie die Probleme behoben haben
-
Sie müssen Ihr Produkt aktualisieren, um die neuen Anforderungen zu erfüllen
| Kategorie | Richtlinien |
|---|---|
| API- und Agentenfunktionalität | Alle APIs sollten funktionsfähig sein und angemessen reagieren. Wenn Sie einen Agenten angeben, muss die Lösung autonome Fähigkeiten nachweisen, indem sie ohne explizite externe Befehle oder ständige menschliche Eingaben funktioniert. |
| API-Zugriff und Authentifizierung | Der Kunde sollte in der Lage sein, Ihren Eintrag zu abonnieren und API-Schlüssel abzurufen oder die Schritte zur Generierung des OAuth Tokens zu befolgen. |
| Architektur-Richtlinien | Weitere Informationen finden Sie in den Architekturrichtlinien. |
| Anforderungen bezüglich Kundeninformationen | Weitere Informationen finden Sie in den Anforderungen an Kundeninformationen. |
| Schlüsselverwaltung | Anbieter sollten den Kunden die Möglichkeit geben, invalidate/rotate Schlüssel zu erhalten. Anbieter sollten auch über einen Mechanismus verfügen, mit dem Schlüssel ungültig gemacht werden können, sobald sich der Kunde von dem Angebot abmeldet. |
| MCP-Serveranforderungen (falls zutreffend) | Für MCP-Server sollten Anbieter Informationen zur Remote-MCP-Konfiguration zusammen mit allen Voraussetzungen oder Umgebungsvariablen für die Einrichtung bereitstellen. |
| Einrichtung des Produkts | Weitere Informationen finden Sie in den Richtlinien zur Produkteinrichtung. |
| Produktnutzung | Weitere Informationen finden Sie in den Richtlinien zur Produktnutzung. |
| Anweisungen zur Verwendung | In den Nutzungsanweisungen sollten die Voraussetzungen, die Einrichtung der Authentifizierung, die unterstützten Endpunkte, das request/response Schema, die Toolbeschreibung, die Fehlercodes und zusätzliche Ressourcen klar angegeben sein. |
Integration von API-basierten KI-Agent-Produkten
Integration auf der Grundlage der Produktpreise
Die Integration Ihres Produkts AWS Marketplace ist ein Schritt bei der Angebotserstellung eines API-basierten AI-Agent-Produkts. Um Ihr API-basiertes AI-Agent-Produkt zu integrieren AWS Marketplace, müssen Sie Code schreiben und nachweisen, dass es erfolgreich auf mehrere Kundenszenarien reagieren kann.
Informationen zur Integration Ihres Produkts auf der Grundlage verschiedener Preismodelle finden Sie in den folgenden Themen:
-
Informationen zu Produkten auf Abonnementbasis finden Sie unter. Integrieren Sie Ihr SaaS-Abonnement oder Pay-As-You-Go -Produkt mit AWS Marketplace
-
Informationen zu vertragsbasierten Produkten finden Sie unter. Integrieren Sie Ihr SaaS-Vertragsprodukt mit AWS Marketplace
-
Informationen über Verträge mit pay-as-you-go Produkten finden Sie unter. Integrieren Sie Ihr vertragsbasiertes SaaS-Produkt mit AWS Marketplace
Kunden-Onboarding
Zur Auftragsabwicklung auf der Website weiterleiten
Wenn Kunden Ihr Produkt abonnieren AWS Marketplace, greifen sie in Ihrer AWS-Umgebung auf das Produkt zu. Nach dem Abonnieren leiten wir Kunden auf die Website Ihres Produkts weiter, um ihr Konto zu registrieren und das Produkt zu konfigurieren.
-
Weitere Informationen zum Onboarding von Kunden mithilfe von Redirect to Website Fulfillment finden Sie unter. Kunden in Ihr SaaS-Produkt einbinden über AWS Marketplace
QuickLaunch Erfüllung
Wenn Kunden Ihr Produkt über abonnieren AWS Marketplace, erhalten sie einen API-Schlüssel oder OAuth Anmeldeinformationen, um Aufrufe an Ihren API-Endpunkt oder MCP-Server zu tätigen. Das Verfahren funktioniert folgendermaßen:
-
Der Kunde abonniert das Produkt.
-
Der Kunde registriert sich oder meldet sich mit einem Konto auf Ihrer Website an.
-
Sie verwenden die PutDeploymentParameterAPI, um den API-Schlüssel oder die OAuth Anmeldeinformationen im AWS Secrets Manager des Kunden zu speichern.
Wenn Sie bei API-Schlüsseln einen Parameter speichern, rufen Sie die
PutDeploymentParameterAPI auf, wobei dersecretStringParameter eine Zeichenfolge ist. Wenn Sie bei OAuth Anmeldeinformationen mehr als einen Parameter speichern, geben Sie eine JSON-Zeichenfolge mit Schlüssel-Wert-Paaren imsecretStringParameter an, wie unten dargestellt:{ "Client Id": "12345", "Client Secret": "12345", "Discovery URL" : "https://auth.example.com/.well-known/openid-configuration" }
In diesen Ressourcen erfahren Sie mehr über QuickLaunch Fulfillment:
-
Erfahren Sie mehr über PutDeploymentParameterAPI in AWS Marketplace Deployment API
-
Anweisungen zum Onboarding von Kunden finden Sie unter Kunden in Ihr SaaS-Produkt einbinden über AWS Marketplace
Zugreifen AWS Marketplace APIs
Im folgenden Abschnitt wird der Prozess der Integration mit dem AWS Marketplace Metering Service oder AWS Marketplace Entitlement Service beschrieben, mit dem sichergestellt wird, dass Ihre Abrechnung und Berichterstattung über die Nutzung Ihrer Produkte durch Kunden korrekt sind.
-
Weitere Informationen zum Zugriff finden Sie AWS Marketplace APIs unterZugriff auf den AWS Marketplace Metering and Entitlement Service APIs.
SNS-Benachrichtigungen
Abonnieren Sie die Themen des Amazon Simple Notification Service (Amazon SNS), um Benachrichtigungen über Abonnementänderungen von Kunden und Vertragsansprüche für Ihre Produkte zu erhalten. AWS Marketplace stellt diese Themen während der Produkterstellung zur Verfügung, um Ihnen bei der Verwaltung des Kundenzugangs zu helfen.
Die folgenden Amazon SNS SNS-Themen sind für SaaS-API-basierte Produkte verfügbar:
-
Amazon SNS SNS-Thema: aws-mp-entitlement-notification— Benachrichtigt Sie, wenn Kunden Verträge erstellen, aktualisieren oder verlängern oder wenn Verträge ablaufen. Dies ist nur für Produkte mit Preismodellen verfügbar, die einen Vertrag beinhalten.
-
Amazon SNS SNS-Thema: aws-mp-subscription-notification— Benachrichtigt Sie, wenn Kunden Ihr Produkt abonnieren oder abbestellen, und enthält die Kennzeichnung
offer-identifierfür private Angebote und eine kostenlose Testversion für kostenlose SaaS-Testversionen. Dies ist für alle Preismodelle verfügbar, einschließlich Verträge und Abonnements.
Vorlagen für Nutzungsanweisungen
Vorlage für Anweisungen zur Verwendung des MCP-Servers
Das folgende Beispiel zeigt Anweisungen zur Verwendung eines MCP-Servers, einschließlich Toolbeschreibungen, Voraussetzungen, Einrichtung der Authentifizierung, Konfiguration für beliebte Clients, Ratenbegrenzungen und zusätzlicher Ressourcen:
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
Vorlage für Anweisungen zur Verwendung von AI Agent und Agent & Tools
Das folgende Beispiel zeigt Anweisungen zur Verwendung eines Agenten oder von Agent-Tools, einschließlich der Voraussetzungen, der Einrichtung der Authentifizierung, der unterstützten Endpunkte, des request/response Schemas, der Fehlercodes und zusätzlicher Ressourcen:
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