Referensi API AWS Marketplace direstrukturisasi. Untuk informasi selengkapnya tentang operasi API yang didukung, lihat Referensi API AWS Marketplace.

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

Bekerja dengan produk SaaS menggunakan AWS Marketplace API

Anda dapat menggunakan AWS Marketplace Catalog API untuk mengotomatiskan tugas untuk bekerja dengan SaaS-based produk. Untuk informasi tentang membuat SaaS-based produk, lihatBuat produk. Topik berikut menjelaskan cara melakukan tindakan API Katalog:

Konfigurasikan model harga gratis untuk produk SaaS

Produk SaaS dapat ditawarkan dengan model harga Gratis, yang memungkinkan pembeli untuk menggunakan produk Anda tanpa biaya. Saat menggunakan model harga gratis untuk produk SaaS, Anda harus mengonfigurasi dimensi harga dengan harga nol dolar di salah satu UsageBasedPricingTerm atau ConfigurableUpfrontPricingTerm.

Untuk mengonfigurasi harga gratis untuk produk SaaS:

Saat mengonfigurasi penawaran, pastikan bahwa:

Opsi Peluncuran Cepat SaaS

Untuk informasi tentang opsi Peluncuran Cepat, lihat sumber daya berikut:

Tambahkan opsi pengiriman

Anda dapat menggunakan API Katalog untuk menambahkan opsi pengiriman untuk produk SaaS di AWS Marketplace. Opsi pengiriman API memungkinkan penjual menawarkan API-based layanan yang terintegrasi dengan AWS layanan seperti Amazon Bedrock untuk alur kerja agen AI.

Untuk menambahkan opsi pengiriman API, panggil operasi StartChangeSet API dengan jenis AddDeliveryOptions perubahan untuk menambahkan detail pengiriman, seperti yang ditunjukkan pada contoh berikut.

Topik berikut menjelaskan cara menambahkan SaaSUrlDeliveryOptionDetails opsi ApiDeliveryOptionDetails gunakan dan.

ApiDeliveryOptionDetails

Contoh di bagian ini mendukung jenis opsi ApiDeliveryOptionDetails pengiriman, yang memungkinkan Anda menentukan titik akhir API, metode otentikasi, dan protokol integrasi untuk produk SaaS Anda.

Minta Sintaks

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
   {
  "ChangeType": "AddDeliveryOptions",
  "Entity": {
    "Identifier": "prod-1234567890123",
    "Type": "SaaSProduct@1.0"
  },
  "Details": {
    "DeliveryOptions": [
      {
        "Details": {
          "ApiDeliveryOptionDetails": {
            "ApiType": "AGENT",
            "QuickLaunchEnabled": true,
            "FulfillmentUrl": "https://example.com/fulfillment",
            "UsageInstructions": "# Getting Started\\n\\nTo use this API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
            "CompatibleServices": ["Bedrock-AgentCore"],
            "Endpoints": [
              {
                "Name": "GenerateContent",
                "EndpointUrl": "https://api.example.com/v1/{tenantId}/generate",
                "EndpointType": "DYNAMIC",
                "EndpointUrlParameters": [
                  {
                    "Name": "tenantId",
                    "Description": "The unique identifier for the buyer's tenant",
                    "DefaultValue": "default"
                  }
                ],
                "Description": "Generate content using AI models",
                "AuthorizationTypes": ["API_KEY"],
                "Schemas": [{
                  "Type": "OPEN_API",
                  "SchemaUrl": "https://example.com/schemas/example-schema.json"
                }],
                "IntegrationProtocols": [
                  {
                    "Type": "MCP",
                    "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  }
}

Berikan informasi untuk bidang untuk menambahkan jenis AddDeliveryOptions perubahan:

Sintaks Respons

Kumpulan perubahan dibuat untuk permintaan Anda. Tanggapan terhadap permintaan ini memberi Anda ID untuk set perubahan dan terlihat seperti berikut ini.

{
"ChangeSetId": "example123456789012abcdef", 
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

Validasi Sinkron

Kesalahan Asinkron

Perbarui opsi pengiriman

Anda dapat menggunakan API Katalog untuk memperbarui opsi pengiriman untuk produk SaaS di AWS Marketplace.

Untuk memperbarui opsi pengiriman, panggil operasi StartChangeSet API dengan jenis UpdateDeliveryOptions perubahan, seperti yang ditunjukkan pada contoh berikut.

Minta Sintaks

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "ApiDeliveryOptionDetails": {
                                "ApiType": "AGENT",
                                "QuickLaunchEnabled": true,
                                "FulfillmentUrl": "https://example.com/fulfillment-updated",
                                "UsageInstructions": "# Updated Getting Started\\n\\nTo use this updated API:\\n1. Register for an API key\\n2. Configure your endpoint\\n3. Start making requests",
                                "CompatibleServices": ["Bedrock-AgentCore"],
                                "Endpoints": [
                                    {
                                        "Name": "GenerateContent",
                                        "EndpointUrl": "https://api.example.com/v2/{tenantId}/generate",
                                        "EndpointType": "DYNAMIC",
                                        "EndpointUrlParameters": [
                                            {
                                                "Name": "tenantId",
                                                "Description": "The unique identifier for the buyer's tenant",
                                                "DefaultValue": "default"
                                            }
                                        ],
                                        "Description": "Generate content using updated AI models",
                                        "AuthorizationTypes": ["API_KEY", "OAUTH2"],
                                        "Schemas": [{
                                            "Type": "OPEN_API",
                                            "SchemaUrl": "https://example.com/schemas/updated-schema.json"
                                        }],
                                        "IntegrationProtocols": [
                                            {
                                                "Type": "MCP",
                                                "UsageInstructions": "Connect using Model Context Protocol for seamless integration"
                            }
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Berikan informasi untuk bidang untuk memperbarui jenis UpdateDeliveryOptions perubahan dengan opsi pengiriman API:

Sintaks Respons

{
"ChangeSetId": "example123456789012abcdef", 
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu mulai dari beberapa menit hingga beberapa jam. Anda dapat memeriksa status permintaan melalui Portal Manajemen AWS Marketplace, atau di Katalog API dengan DescribeChangeSet tindakan.

Validasi Sinkron

Kesalahan Asinkron

Perbarui visibilitas opsi pengiriman

Anda dapat menggunakan API Katalog untuk mengonfigurasi izin sehingga hanya beberapa pengguna yang dapat mengubah visibilitas untuk produk SaaS di AWS Marketplace.

Untuk mengonfigurasi izin sehingga hanya beberapa pengguna yang dapat mengubah visibilitas untuk produk SaaS, panggil operasi StartChangeSet API dengan jenis UpdateDeliveryOptionsVisibility perubahan, seperti yang ditunjukkan pada contoh berikut.

Minta Sintaks

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis UpdateDeliveryOptionsVisibility perubahan:

Sintaks Respons

{
"ChangeSetId": "example123456789012abcdef", 
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu mulai dari beberapa menit hingga beberapa jam. Anda dapat memeriksa status permintaan melalui Portal Manajemen AWS Marketplace, atau di Katalog API dengan DescribeChangeSet tindakan.

Validasi Sinkron

Kesalahan Asinkron

SaaSUrlDeliveryOption

Contoh berikut menunjukkan cara menggunakan SaaSUrlDeliveryOptionDetails untuk memperbaruiFulfillmentUrl.

Minta Sintaks

POST /StartChangeSet HTTP/1.1 
Content-type: application/json
     
{
    "Catalog": "AWSMarketplace",
    "ChangeSet": [
        {
            "ChangeType": "UpdateDeliveryOptions",
            "Entity": {
                "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
                "Type": "SaaSProduct@1.0"
            },
            "DetailsDocument": {
                "DeliveryOptions": [
                    {
                        "Id": "do-1234567891234567891234",
                        "Details": {
                            "SaaSUrlDeliveryOptionDetails": {
                                "FulfillmentUrl": "https://www.aws.amazon.com/marketplace/management",
                                "LaunchUrl": "URL",
                                "UsageInstructions": "Instructions",
                                "DeploymentTemplates": [
                                    {
                                        "Title": "CloudFormation Template 123",
                                        "Description": "CloudFormation description",
                                        "IamPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:Get*\",\"s3:List*\"],\"Resource\":\n[\"arn:aws:s3:::amzn-s3-demo-bucket\",\"arn:aws:s3:::amzn-s3-demo-bucket/*\"]}]}"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Berikan informasi untuk bidang untuk menambahkan jenis AddDeliveryOptions perubahan:

Sintaks Respons

{
"ChangeSetId": "example123456789012abcdef", 
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikannya memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu mulai dari beberapa menit hingga beberapa jam. Anda dapat memeriksa status permintaan melalui Portal Manajemen AWS Marketplace, atau di Katalog API dengan DescribeChangeSet tindakan.

Validasi Sinkron

Kesalahan Asinkron

Perbarui visibilitas opsi pengiriman

Anda dapat menggunakan API Katalog untuk mengonfigurasi izin sehingga hanya beberapa pengguna yang dapat mengubah visibilitas untuk produk SaaS di AWS Marketplace.

Untuk melakukannya, panggil operasi StartChangeSet API dengan tipe UpdateDeliveryOptionsVisibility perubahan, seperti yang ditunjukkan pada contoh berikut.

Minta Sintaks

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          },
          {
            "Id": "do-43210987654321",
            "TargetVisibility": "Limited",
            "Targeting":
            {
              "PositiveTargeting":
              {
                "BuyerAccounts":
                [
                  "123456789012"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

Berikan informasi untuk bidang untuk menambahkan jenis UpdateDeliveryOptionsVisibility perubahan:

Sintaks Respons

{
"ChangeSetId": "example123456789012abcdef", 
"ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

Permintaan perubahan ditambahkan ke antrian dan diproses. Ini termasuk memvalidasi informasi untuk memastikan bahwa itu memenuhi AWS Marketplace pedoman. Proses validasi dapat memakan waktu mulai dari beberapa menit hingga beberapa jam. Anda dapat memeriksa status permintaan melalui Portal Manajemen AWS Marketplace, atau di Katalog API dengan DescribeChangeSet tindakan.

Validasi Sinkron

Kesalahan Asinkron