View a markdown version of this page

Mengintegrasikan produk agen AI berbasis API - AWS Marketplace

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengintegrasikan produk agen AI berbasis API

Pedoman produk agen AI berbasis API

AWS Marketplace memberikan pedoman untuk semua produk agen AI berbasis API perangkat lunak sebagai layanan (SaaS). Pedoman ini memastikan pengalaman yang aman dan dapat dipercaya bagi pelanggan.

Proses peninjauan produk

Saat Anda mengirimkan produk, AWS Marketplace tinjau produk dan metadatanya untuk memverifikasi bahwa produk tersebut memenuhi pedoman saat ini. Kami secara teratur memperbarui pedoman ini untuk mengatasi persyaratan keamanan yang terus berkembang.

Mempertahankan kepatuhan

AWS Marketplace terus memantau produk untuk memverifikasi kepatuhan. Jika produk Anda tidak memenuhi pedoman saat ini:

  • Produk Anda mungkin tidak tersedia untuk pelanggan baru sampai Anda menyelesaikan masalah

  • Anda harus memperbarui produk Anda untuk memenuhi persyaratan baru

Kategori Pedoman
Fungsionalitas API dan agen Semua APIs harus fungsional dan merespons kembali dengan tepat. Jika Anda mendaftarkan Agen, solusinya harus menunjukkan kemampuan otonom dengan beroperasi tanpa perintah eksternal eksplisit atau input manusia yang konstan.
Akses dan otentikasi API Pelanggan harus dapat berlangganan daftar Anda dan mengambil Kunci API atau mengikuti langkah-langkah untuk menghasilkan OAuth token.
Pedoman arsitektur Ikuti panduan Arsitektur untuk lebih jelasnya.
Persyaratan informasi pelanggan Ikuti persyaratan informasi Pelanggan untuk lebih jelasnya.
Manajemen kunci Vendor harus memberikan pelanggan kemampuan untuk invalidate/rotate kunci. Vendor juga harus memiliki mekanisme untuk membatalkan kunci setelah pelanggan berhenti berlangganan dari daftar.
Persyaratan server MCP (jika ada) Untuk MCP Server, vendor harus menyediakan rincian konfigurasi MCP jarak jauh di samping setiap prasyarat atau variabel lingkungan untuk disiapkan.
Penyiapan produk Ikuti pedoman penyiapan Produk untuk detail selengkapnya.
Penggunaan produk Ikuti pedoman penggunaan Produk untuk detail selengkapnya.
Instruksi penggunaan Instruksi penggunaan harus dengan jelas menyatakan prasyarat, pengaturan otentikasi, titik akhir yang didukung, request/response skema, deskripsi alat, kode kesalahan, dan sumber daya tambahan.

Mengintegrasikan produk agen AI berbasis API

Integrasi berdasarkan harga produk

Mengintegrasikan produk Anda dengan AWS Marketplace adalah salah satu langkah dalam daftar produk agen AI berbasis API. Untuk mengintegrasikan produk agen AI berbasis API Anda AWS Marketplace, Anda harus menulis kode dan menunjukkan bahwa ia dapat merespons dengan sukses beberapa skenario pelanggan.

Untuk informasi tentang mengintegrasikan produk Anda berdasarkan model harga yang berbeda, lihat topik berikut:

Orientasi pelanggan

Pengalihan ke pemenuhan Situs Web

Saat pelanggan berlangganan produk Anda AWS Marketplace, mereka mengakses produk di lingkungan AWS Anda. Setelah berlangganan, kami mengarahkan pelanggan ke situs web produk Anda untuk mendaftarkan akun mereka dan mengonfigurasi produk.

QuickLaunch pemenuhan

Ketika pelanggan berlangganan produk Anda melalui AWS Marketplace, mereka menerima kunci API atau OAuth kredensional untuk melakukan panggilan ke endpoint API atau server MCP Anda. Prosesnya bekerja sebagai berikut:

  • Pelanggan berlangganan produk.

  • Pelanggan mendaftar atau masuk ke akun di situs web Anda.

  • Anda menggunakan PutDeploymentParameterAPI untuk menyimpan kunci API atau OAuth kredensional di AWS Secrets Manager pelanggan.

  • Jika Anda menyimpan satu parameter dalam kasus kunci API, panggil PutDeploymentParameter API dengan secretString parameter menjadi string. Jika Anda menyimpan lebih dari satu parameter dalam kasus OAuth kredensional, berikan string JSON dengan pasangan kunci-nilai dalam parameter seperti yang ditunjukkan di bawah inisecretString:

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

Pelajari lebih lanjut tentang QuickLaunch pemenuhan dalam sumber daya ini:

Mengakses AWS Marketplace APIs

Bagian berikut ini menguraikan proses integrasi dengan Layanan Pengukuran atau Layanan AWS Marketplace AWS Marketplace Hak, yang digunakan untuk memastikan bahwa penagihan dan pelaporan Anda untuk penggunaan pelanggan atas produk Anda akurat.

Notifikasi SNS

Berlangganan topik Amazon Simple Notification Service (Amazon SNS) untuk menerima pemberitahuan tentang perubahan langganan pelanggan dan hak kontrak untuk produk Anda. AWS Marketplace menyediakan topik ini selama pembuatan produk untuk membantu Anda mengelola akses pelanggan.

Topik Amazon SNS berikut tersedia untuk produk berbasis SaaS API:

  • Topik Amazon SNS: aws-mp-entitlement-notification— Memberitahu Anda ketika pelanggan membuat, meningkatkan, atau memperbarui kontrak, atau ketika kontrak berakhir. Ini hanya tersedia untuk produk dengan model harga yang mencakup kontrak.

  • Topik Amazon SNS: aws-mp-subscription-notification— Memberitahu Anda ketika pelanggan berlangganan atau berhenti berlangganan dari produk Anda dan menyertakan offer-identifier untuk penawaran pribadi dan bendera uji coba gratis untuk uji coba gratis SaaS. Ini tersedia untuk semua model harga, termasuk kontrak dan langganan.

Template petunjuk penggunaan

Templat instruksi penggunaan server MCP

Contoh berikut menunjukkan petunjuk penggunaan untuk server MCP, termasuk deskripsi alat, prasyarat, pengaturan otentikasi, konfigurasi untuk klien populer, batas tarif, dan sumber daya tambahan:

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

Templat instruksi penggunaan Agen dan Agen & Alat AI

Contoh berikut menunjukkan petunjuk penggunaan untuk alat Agen atau Agen, termasuk prasyarat, penyiapan otentikasi, titik akhir yang didukung, request/response skema, kode kesalahan, dan sumber daya tambahan:

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