翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # API ベースの AI エージェント製品の統合 ## API ベースの AI エージェント製品ガイドライン AWS Marketplace は、すべての Software as a Service (SaaS) API ベースの AI エージェント製品に関するガイドラインを提供します。これらのガイドラインは、お客様に安全で信頼できるエクスペリエンスを提供します。 **Topics** + [製品レビュープロセス](#product-review-process) + [コンプライアンスの維持](#maintaining-compliance) ### 製品レビュープロセス 製品を送信すると、 は製品とそのメタデータ AWS Marketplace を確認して、現在のガイドラインを満たしていることを確認します。進化するセキュリティ要件を満たすために、これらのガイドラインを定期的に更新します。 ### コンプライアンスの維持 AWS Marketplace は、製品を継続的にモニタリングしてコンプライアンスを検証します。製品が現在のガイドラインを満たさない場合: + 問題を解決するまで、新しいサブスクライバーは製品を使用できない可能性があります + 新しい要件を満たすように製品を更新する必要があります | Category | ガイドライン | | --- | --- | | API とエージェントの機能 | すべての API は機能し、適切に応答する必要があります。エージェントを一覧表示する場合、ソリューションは明示的な外部コマンドや一定の人的入力なしで動作することにより、自律的な機能を示す必要があります。 | | API アクセスと認証 | お客様は、出品をサブスクライブして API キーを取得するか、手順に従って OAuth トークンを生成できる必要があります。 | | アーキテクチャガイドライン | [詳細については、アーキテクチャガイドラインに従ってください。](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-guidelines.html#saas-architecture) | | 顧客情報の要件 | [詳細については、顧客情報の要件に従ってください。](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-guidelines.html#saas-customer-information) | | キー管理 | ベンダーは、顧客がキーを無効化/ローテーションできるようにする必要があります。ベンダーには、顧客が出品からサブスクリプションを解除するとキーを無効にするメカニズムも必要です。 | | MCP サーバーの要件 (該当する場合) | MCP サーバーの場合、ベンダーはセットアップの前提条件または環境変数と併せてリモート MCP 設定の詳細を提供する必要があります。 | | 製品のセットアップ | [詳細については、製品セットアップガイドラインに従ってください。](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-guidelines.html#saas-guidelines-setup) | | 製品の使用 | [詳細については、製品の使用方法ガイドラインに従ってください。](https://docs.aws.amazon.com/marketplace/latest/userguide/saas-guidelines.html#saas-product-usage) | | [使用手順] | 使用手順には、前提条件、認証設定、サポートされているエンドポイント、リクエスト/レスポンススキーマ、ツールの説明、エラーコード、その他のリソースが明確に記載されている必要があります。 | ## API ベースの AI エージェント製品の統合 ### 製品価格設定に基づく統合 製品を と統合することは、API ベースの AI エージェント製品を一覧表示する 1 つのステップ AWS Marketplace です。API ベースの AI エージェント製品を と統合するには AWS Marketplace、コードを記述し、いくつかの顧客シナリオに正常に応答できることを示す必要があります。 さまざまな料金モデルに基づいて製品を統合する方法については、以下のトピックを参照してください。 + サブスクリプションベースの製品の詳細については、「[SaaS サブスクリプションまたはPay-As-You-Go製品と の統合 AWS Marketplace](saas-integrate-subscription.md)」を参照してください。 + コンテナベースの製品の詳細については、「[SaaS 契約製品を と統合する AWS Marketplace](saas-integrate-contract.md)」を参照してください。 + 従量制料金製品との契約については、「[SaaS 契約ベースの製品を と統合する AWS Marketplace](saas-integrate-contract-with-pay.md)」を参照してください。 ### 顧客オンボーディング #### [ウェブサイトにリダイレクトする] フルフィルメント 顧客が を通じて製品をサブスクライブすると AWS Marketplace、AWS 環境の製品にアクセスします。サブスクライブした後、お客様を製品のウェブサイトに誘導し、アカウントを登録して製品を設定します。 + [を使用して SaaS 製品に顧客をオンボーディングする AWS Marketplace](saas-product-customer-setup.md) で [ウェブサイトにリダイレクトする] フルフィルメントを使用して顧客をオンボーディングする方法について説明します。 #### QuickLaunch フルフィルメント 顧客が を通じて製品をサブスクライブすると AWS Marketplace、API エンドポイントまたは MCP サーバーを呼び出すための API キーまたは OAuth 認証情報を受け取ります。このプロセスは次のように機能します。 + お客様は製品をサブスクライブします。 + お客様は、ウェブサイトのアカウントにサインアップまたはサインインします。 + **PutDeploymentParameter** API を使用して、API キーまたは OAuth 認証情報をお客様の AWS Secrets Manager に保存します。 + API キーの場合に 1 つのパラメータを保存するには、`secretString` パラメータを文字列として `PutDeploymentParameter` API を呼び出します。OAuth 認証情報の場合に複数のパラメータを保存するには、次に示すように、`secretString` パラメータにキーと値のペアを含む JSON 文字列を指定します。 ``` { "Client Id": "{{12345}}", "Client Secret": "{{12345}}", "Discovery URL" : "{{https://auth.example.com/.well-known/openid-configuration}}" } ``` QuickLaunch フルフィルメントの詳細については、以下のリソースで説明します。 + [AWS Marketplace デプロイ API](https://docs.aws.amazon.com/marketplace/latest/APIReference/API_Operations_AWS_Marketplace_Deployment_Service.html) の **PutDeploymentParameter** API について説明します。 + [を使用して SaaS 製品に顧客をオンボーディングする AWS Marketplace](saas-product-customer-setup.md) でお客様のオンボーディング手順を確認する ### AWS Marketplace APIs へのアクセス 次のセクションでは、 を AWS Marketplace Metering Service または AWS Marketplace Entitlement Service と統合するプロセスの概要を説明します。これは、製品の顧客使用状況の請求とレポートが正確であることを確認するために使用されます。 + AWS Marketplace APIs「」を参照してください[AWS Marketplace Metering and Entitlement Service APIsへのアクセス](saas-integration-metering-and-entitlement-apis.md)。 ### SNS 通知 Amazon Simple Notification Service (Amazon SNS) トピックをサブスクライブして、製品の顧客サブスクリプションの変更と契約の使用権限に関する通知を受け取ります。 は、顧客アクセスの管理に役立つように、製品の作成中にこれらのトピック AWS Marketplace を提供します。 次の Amazon SNS トピックは SaaS API ベースの製品で使用できます。 + [Amazon SNS トピック: `aws-mp-entitlement-notification`](saas-notification.md#saas-sns-message-body) – お客様が契約を作成、アップグレード、更新したとき、または契約の有効期限が切れたときに通知します。これは、契約を含む料金モデルを持つ製品でのみ使用できます。 + [Amazon SNS トピック: `aws-mp-subscription-notification`](saas-notification.md#saas-sns-subscription-message-body) - お客様が製品をサブスクライブまたはサブスクライブ解除したときに通知します。これには、プライベートオファーの場合は `offer-identifier` が、SaaS 無料トライアルの場合は無料トライアルフラグが含まれます。これは、契約やサブスクリプションを含むすべての料金モデルで使用できます。 ## 使用手順テンプレート ### MCP サーバーの使用手順テンプレート 次の例は、ツールの説明、前提条件、認証設定、一般的なクライアントの設定、レート制限、追加リソースなど、MCP サーバーの使用手順を示しています。 ``` 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 " ] }, } } ``` **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 ``` ### AI エージェントおよびエージェントとツールの使用手順テンプレート 次の例は、前提条件、認証設定、サポートされているエンドポイント、リクエスト/レスポンススキーマ、エラーコード、その他のリソースなど、エージェントまたはエージェントツールの使用手順を示しています。 ``` 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 ```