La référence de l'API AWS Marketplace a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez le manuel AWS Marketplace API Reference.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Travaillez avec des produits SaaS à l'aide du AWS Marketplace API

Vous pouvez les utiliser AWS Marketplace Catalog API pour automatiser les tâches liées à l'utilisation des SaaS-based produits. Pour plus d'informations sur la création de SaaS-based produits, consultezCréation d'un produit. Les rubriques suivantes décrivent comment exécuter les actions de l'API Catalog :

Configurer le modèle de tarification gratuit pour les produits SaaS

Les produits SaaS peuvent être proposés avec un modèle de tarification gratuit, qui permet aux acheteurs d'utiliser votre produit gratuitement. Lorsque vous utilisez le modèle de tarification gratuit pour les produits SaaS, vous devez configurer les dimensions de tarification avec une tarification zéro dollar dans l'une UsageBasedPricingTerm ou ConfigurableUpfrontPricingTerm l'autre des options.

Pour configurer la tarification gratuite pour un produit SaaS :

Lors de la configuration de l'offre, assurez-vous que :

Options de lancement rapide en mode SaaS

Pour plus d'informations sur les options de lancement rapide, consultez les ressources suivantes :

Ajouter des options de livraison

Vous pouvez utiliser l'API Catalog pour ajouter des options de livraison pour un produit SaaS dans AWS Marketplace. Les options de diffusion par API permettent aux vendeurs de proposer API-based des services qui s'intègrent à des AWS services tels qu'Amazon Bedrock pour les flux de travail des agents IA.

Pour ajouter des options de diffusion d'API, appelez l'opération d'StartChangeSetAPI avec le type de AddDeliveryOptions modification pour ajouter les détails de livraison, comme indiqué dans l'exemple suivant.

Les rubriques suivantes expliquent comment ajouter et utiliser les SaaSUrlDeliveryOptionDetails options ApiDeliveryOptionDetails et.

ApiDeliveryOptionDetails

L'exemple de cette section prend en charge le type d'option de ApiDeliveryOptionDetails livraison, qui vous permet de spécifier les points de terminaison d'API, les méthodes d'authentification et les protocoles d'intégration pour votre produit SaaS.

Syntaxe de la demande

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

Fournissez des informations pour les champs permettant d'ajouter le type de AddDeliveryOptions modification :

Syntaxe de réponse

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ID de l'ensemble de modifications et se présente comme suit.

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

Validations synchrones

Erreurs asynchrones

Mettre à jour les options de livraison

Vous pouvez utiliser l'API Catalog pour mettre à jour les options de livraison d'un produit SaaS dans AWS Marketplace.

Pour mettre à jour les options de diffusion, appelez l'opération d'StartChangeSetAPI avec le type de UpdateDeliveryOptions modification, comme illustré dans l'exemple suivant.

Syntaxe de la demande

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

Fournissez des informations pour les champs afin de mettre à jour le type de UpdateDeliveryOptions modification avec les options de livraison de l'API :

Syntaxe de réponse

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

La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures. Vous pouvez vérifier l'état de la demande via ou dans Portail de gestion AWS Marketplace l'API du catalogue à l'aide de l'DescribeChangeSetaction.

Validations synchrones

Erreurs asynchrones

Mettre à jour la visibilité des options de livraison

Vous pouvez utiliser l'API du catalogue pour configurer les autorisations afin que seuls certains utilisateurs puissent modifier la visibilité d'un produit SaaS dans AWS Marketplace.

Pour configurer les autorisations afin que seuls certains utilisateurs puissent modifier la visibilité d'un produit SaaS, appelez l'opération d'StartChangeSetAPI avec le type de UpdateDeliveryOptionsVisibility modification, comme illustré dans l'exemple suivant.

Syntaxe de la demande

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

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateDeliveryOptionsVisibility modification :

Syntaxe de réponse

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

La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures. Vous pouvez vérifier l'état de la demande via ou dans Portail de gestion AWS Marketplace l'API du catalogue à l'aide de l'DescribeChangeSetaction.

Validations synchrones

Erreurs asynchrones

SaaSUrlDeliveryOption

L'exemple suivant montre comment utiliser le pour mettre SaaSUrlDeliveryOptionDetails à jour leFulfillmentUrl.

Syntaxe de la demande

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

Fournissez des informations pour les champs permettant d'ajouter le type de AddDeliveryOptions modification :

Syntaxe de réponse

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

La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures. Vous pouvez vérifier l'état de la demande via ou dans Portail de gestion AWS Marketplace l'API du catalogue à l'aide de l'DescribeChangeSetaction.

Validations synchrones

Erreurs asynchrones

Mettre à jour la visibilité des options de livraison

Vous pouvez utiliser l'API du catalogue pour configurer les autorisations afin que seuls certains utilisateurs puissent modifier la visibilité d'un produit SaaS dans AWS Marketplace.

Pour ce faire, appelez l'opération StartChangeSet d'API avec le type de UpdateDeliveryOptionsVisibility modification, comme illustré dans l'exemple suivant.

Syntaxe de la demande

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

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateDeliveryOptionsVisibility modification :

Syntaxe de réponse

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

La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures. Vous pouvez vérifier l'état de la demande via ou dans Portail de gestion AWS Marketplace l'API du catalogue à l'aide de l'DescribeChangeSetaction.

Validations synchrones

Erreurs asynchrones