AWS Marketplace API 참조가 재구성되었습니다. 지원되는 API 작업에 대한 자세한 내용은 AWS Marketplace API 참조를 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS MarketplaceAPIs를 사용하여 SaaS 제품 작업

를 사용하여 SaaS 기반 제품 작업을 위한 작업을 자동화AWS Marketplace Catalog API할 수 있습니다. SaaS 기반 제품 생성에 대한 자세한 내용은 섹션을 참조하세요제품 생성. 다음 주제에서는 카탈로그 API 작업을 수행하는 방법을 설명합니다.

SaaS 제품의 무료 요금 모델 구성

SaaS 제품은 구매자가 무료로 제품을 사용할 수 있는 무료 요금 모델과 함께 제공될 수 있습니다. SaaS 제품에 무료 요금 모델을 사용하는 경우 UsageBasedPricingTerm 또는 ConfigurableUpfrontPricingTerm에서 제로 달러 요금으로 요금 차원을 구성해야 합니다.

SaaS 제품의 무료 요금을 구성하려면:

제안을 구성할 때 다음을 확인하세요.

SaaS 빠른 시작 옵션

빠른 시작 옵션에 대한 자세한 내용은 다음 리소스를 참조하세요.

전송 옵션 추가

카탈로그 API를 사용하여의 SaaS 제품에 대한 전송 옵션을 추가할 수 있습니다AWS Marketplace. API 전송 옵션을 사용하면 판매자가 Amazon Bedrock for AI 에이전트 워크플로와 같은 서비스와 통합되는 API 기반 AWS서비스를 제공할 수 있습니다.

API 전송 옵션을 추가하려면 다음 예제와 같이 AddDeliveryOptions 변경 유형으로 StartChangeSet API 작업을 호출하여 전송 세부 정보를 추가합니다.

다음 주제에서는 ApiDeliveryOptionDetails 및 SaaSUrlDeliveryOptionDetails 옵션을 사용하여를 추가하는 방법을 설명합니다.

ApiDeliveryOptionDetails

이 섹션의 예제는 SaaS 제품의 API 엔드포인트, 인증 방법 및 통합 프로토콜을 지정할 수 있는 ApiDeliveryOptionDetails 전송 옵션 유형을 지원합니다.

요청 구문

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 Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다.

동기 검증

비동기 오류

전송 옵션 가시성 업데이트

일부 사용자만 SaaS 제품의 가시성을 변경할 수 있도록 카탈로그 API를 사용하여 권한을 구성할 수 있습니다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 Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다.

동기 검증

비동기 오류

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 Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다.

동기 검증

비동기 오류

전송 옵션 가시성 업데이트

일부 사용자만 SaaS 제품의 가시성을 변경할 수 있도록 카탈로그 API를 사용하여 권한을 구성할 수 있습니다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 Management Portal또는 DescribeChangeSet 작업을 사용하여 카탈로그 API에서 요청 상태를 확인할 수 있습니다.

동기 검증

비동기 오류