Die AWS Marketplace-API-Referenz wurde umstrukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Marketplace-API-Referenz.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Arbeiten Sie mit SaaS-Produkten mithilfe der AWS Marketplace APIs

Sie können die verwenden AWS Marketplace Catalog API , um Aufgaben für die Arbeit mit SaaS-based Produkten zu automatisieren. Informationen zum Erstellen von SaaS-based Produkten finden Sie unterErstellen Sie ein Produkt. In den folgenden Themen wird beschrieben, wie Aktionen der Catalog API ausgeführt werden:

Konfigurieren Sie das kostenlose Preismodell für SaaS-Produkte

SaaS-Produkte können mit einem kostenlosen Preismodell angeboten werden, das es Käufern ermöglicht, Ihr Produkt kostenlos zu nutzen. Wenn Sie das kostenlose Preismodell für SaaS-Produkte verwenden, müssen Sie Preisdimensionen mit Null-Dollar-Preisen in entweder oder UsageBasedPricingTerm konfigurieren. ConfigurableUpfrontPricingTerm

So konfigurieren Sie die kostenlose Preisgestaltung für ein SaaS-Produkt:

Stellen Sie bei der Konfiguration des Angebots sicher, dass:

Optionen für den SaaS-Schnellstart

Informationen zu den Schnellstartoptionen finden Sie in den folgenden Ressourcen:

Lieferoptionen hinzufügen

Sie können die Catalog API verwenden, um Lieferoptionen für ein SaaS-Produkt hinzuzufügen AWS Marketplace. API-Lieferoptionen ermöglichen es Verkäufern, API-based Dienste anzubieten, die sich in AWS Dienste wie Amazon Bedrock für KI-Agenten-Workflows integrieren lassen.

Um API-Lieferoptionen hinzuzufügen, rufen Sie den StartChangeSet API-Vorgang mit dem AddDeliveryOptions Änderungstyp auf, um Lieferdetails hinzuzufügen, wie im folgenden Beispiel gezeigt.

In den folgenden Themen wird erklärt, wie Sie die SaaSUrlDeliveryOptionDetails Optionen ApiDeliveryOptionDetails und hinzufügen.

ApiDeliveryOptionDetails

Das Beispiel in diesem Abschnitt unterstützt den ApiDeliveryOptionDetails Bereitstellungsoptionstyp, mit dem Sie API-Endpunkte, Authentifizierungsmethoden und Integrationsprotokolle für Ihr SaaS-Produkt angeben können.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den AddDeliveryOptions Änderungstyp hinzuzufügen:

Syntax der Antwort

Für Ihre Anfrage wird ein Änderungssatz erstellt. Die Antwort auf diese Anfrage gibt Ihnen die ID für den Änderungssatz und sieht wie folgt aus.

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

Synchrone Validierungen

Asynchrone Fehler

Aktualisieren Sie die Lieferoptionen

Sie können die Catalog API verwenden, um die Lieferoptionen für ein SaaS-Produkt in zu aktualisieren AWS Marketplace.

Um die Lieferoptionen zu aktualisieren, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateDeliveryOptions Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den UpdateDeliveryOptions Änderungstyp mit den API-Lieferoptionen zu aktualisieren:

Syntax der Antwort

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Dazu gehört auch die Überprüfung von Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern. Sie können den Status der Anfrage über die AWS Marketplace Management Portal oder in der Catalog API mit der DescribeChangeSet Aktion überprüfen.

Synchrone Validierungen

Asynchrone Fehler

Sichtbarkeit der Lieferoption aktualisieren

Sie können die Catalog API verwenden, um Berechtigungen so zu konfigurieren, dass nur einige Benutzer die Sichtbarkeit für ein SaaS-Produkt in ändern können AWS Marketplace.

Um Berechtigungen so zu konfigurieren, dass nur einige Benutzer die Sichtbarkeit für ein SaaS-Produkt ändern können, rufen Sie den StartChangeSet API-Vorgang mit dem UpdateDeliveryOptionsVisibility Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den UpdateDeliveryOptionsVisibility Änderungstyp hinzuzufügen:

Syntax der Antwort

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Dazu gehört auch die Überprüfung von Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern. Sie können den Status der Anfrage über die AWS Marketplace Management Portal oder in der Catalog API mit der DescribeChangeSet Aktion überprüfen.

Synchrone Validierungen

Asynchrone Fehler

SaaSUrlDeliveryOption

Das folgende Beispiel zeigt, wie Sie den verwendenSaaSUrlDeliveryOptionDetails, um den zu aktualisierenFulfillmentUrl.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den AddDeliveryOptions Änderungstyp hinzuzufügen:

Syntax der Antwort

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Dazu gehört auch die Überprüfung von Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern. Sie können den Status der Anfrage über die AWS Marketplace Management Portal oder in der Catalog API mit der DescribeChangeSet Aktion überprüfen.

Synchrone Validierungen

Asynchrone Fehler

Sichtbarkeit der Lieferoption aktualisieren

Sie können die Catalog API verwenden, um Berechtigungen so zu konfigurieren, dass nur einige Benutzer die Sichtbarkeit für ein SaaS-Produkt in ändern können AWS Marketplace.

Rufen Sie dazu den StartChangeSet API-Vorgang mit dem UpdateDeliveryOptionsVisibility Änderungstyp auf, wie im folgenden Beispiel gezeigt.

Anforderungssyntax

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

Geben Sie Informationen für die Felder ein, um den UpdateDeliveryOptionsVisibility Änderungstyp hinzuzufügen:

Syntax der Antwort

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

Die Änderungsanforderung wird einer Warteschlange hinzugefügt und verarbeitet. Dazu gehört auch die Überprüfung von Informationen, um sicherzustellen, dass sie den AWS Marketplace Richtlinien entsprechen. Der Validierungsvorgang kann zwischen einigen Minuten und einigen Stunden dauern. Sie können den Status der Anfrage über die AWS Marketplace Management Portal oder in der Catalog API mit der DescribeChangeSet Aktion überprüfen.

Synchrone Validierungen

Asynchrone Fehler