AWS Marketplace API 參考已重組。如需支援的 API 操作的詳細資訊，請參閱 AWS Marketplace API 參考。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 AWS MarketplaceAPIs 使用 SaaS 產品

您可以使用 AWS Marketplace Catalog API自動化使用 SaaS 型產品的任務。如需建立 SaaS 型產品的相關資訊，請參閱 建立產品。下列主題說明如何執行目錄 API 動作：

設定 SaaS 產品的免費定價模型

SaaS 產品可以免費定價模式提供，這可讓買方免費使用您的產品。為 SaaS 產品使用免費定價模式時，您必須在 UsageBasedPricingTerm 或 ConfigurableUpfrontPricingTerm 中設定定價維度與零美元定價。

若要設定 SaaS 產品的免費定價：

設定優惠時，請確保：

SaaS Quick Launch 選項

如需快速啟動選項的詳細資訊，請參閱下列資源：

新增交付選項

您可以使用目錄 API 來新增 SaaS 產品的交付選項AWS Marketplace。API 交付選項可讓賣方提供與 Amazon Bedrock for AI 代理程式工作流程等AWS服務整合的 API 型服務。

若要新增 API 交付選項，請使用AddDeliveryOptions變更類型呼叫 StartChangeSet API 操作來新增交付詳細資訊，如下列範例所示。

下列主題說明如何新增 使用 ApiDeliveryOptionDetails和 SaaSUrlDeliveryOptionDetails選項。

ApiDeliveryOptionDetails

本節中的範例支援 ApiDeliveryOptionDetails交付選項類型，可讓您指定 SaaS 產品的 API 端點、身分驗證方法和整合通訊協定。

請求語法

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/generate",
                "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"
                  }
                ]
              }
            ]
          }
        }
      }
    ]
  }
}

提供要新增AddDeliveryOptions變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應會為您提供變更集的 ID，如下所示。

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

同步驗證

非同步錯誤

更新交付選項

您可以使用目錄 API 來更新 中 SaaS 產品的交付選項AWS Marketplace。

若要更新交付選項，請使用UpdateDeliveryOptions變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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/generate",
                                        "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"
                            }
                                        ]
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

提供欄位的資訊，以使用 API 交付選項更新UpdateDeliveryOptions變更類型：

回應語法

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

非同步錯誤

更新交付選項可見性

您可以使用目錄 API 來設定許可，以便只有一些使用者可以變更 SaaS 產品的可見性AWS Marketplace。

若要設定許可，以便只有部分使用者可以變更 SaaS 產品的可見性，請使用UpdateDeliveryOptionsVisibility變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

提供要新增UpdateDeliveryOptionsVisibility變更類型的欄位資訊：

回應語法

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾小時。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

非同步錯誤

SaaSUrlDeliveryOption

下列範例示範如何使用 SaaSUrlDeliveryOptionDetails更新 FulfillmentUrl。

請求語法

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/*\"]}]}"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

提供要新增AddDeliveryOptions變更類型的欄位資訊：

回應語法

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

非同步錯誤

更新交付選項可見性

您可以使用目錄 API 來設定許可，以便只有一些使用者可以變更 SaaS 產品的可見性AWS Marketplace。

若要這樣做，請使用UpdateDeliveryOptionsVisibility變更類型呼叫 StartChangeSet API 操作，如下列範例所示。

請求語法

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"
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

提供要新增UpdateDeliveryOptionsVisibility變更類型的欄位資訊：

回應語法

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

非同步錯誤