L'AWS Marketplace API Reference è stato ristrutturato. Per ulteriori informazioni sulle operazioni API supportate, consulta l'AWS Marketplace API Reference.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Lavora con prodotti SaaS utilizzando Marketplace AWS API

Puoi utilizzarli AWS Marketplace Catalog API per automatizzare le attività relative all'utilizzo dei prodotti. SaaS-based Per informazioni sulla creazione di SaaS-based prodotti, consultaCrea un prodotto. I seguenti argomenti descrivono come eseguire le azioni dell'API del catalogo:

Configura il modello di prezzo gratuito per i prodotti SaaS

I prodotti SaaS possono essere offerti con un modello di prezzo gratuito, che consente agli acquirenti di utilizzare il prodotto senza alcun costo. Quando si utilizza il modello di prezzo gratuito per i prodotti SaaS, è necessario configurare le dimensioni dei prezzi con prezzi a zero dollari in uno dei due. UsageBasedPricingTerm ConfigurableUpfrontPricingTerm

Per configurare i prezzi gratuiti per un prodotto SaaS:

Durante la configurazione dell'offerta, assicurati che:

Opzioni SaaS Quick Launch

Per informazioni sulle opzioni di avvio rapido, consulta le seguenti risorse:

Aggiungi opzioni di consegna

Puoi utilizzare l'API Catalog per aggiungere opzioni di consegna per un prodotto SaaS in. Marketplace AWS Le opzioni di distribuzione delle API consentono ai venditori di offrire API-based servizi che si integrano con AWS servizi come Amazon Bedrock for AI agent flows.

Per aggiungere opzioni di consegna dell'API, chiama l'operazione StartChangeSet API con il tipo di AddDeliveryOptions modifica per aggiungere i dettagli di consegna, come mostrato nell'esempio seguente.

I seguenti argomenti spiegano come aggiungere e utilizzare le SaaSUrlDeliveryOptionDetails opzioni ApiDeliveryOptionDetails and.

ApiDeliveryOptionDetails

L'esempio in questa sezione supporta il tipo di opzione di ApiDeliveryOptionDetails consegna, che consente di specificare endpoint API, metodi di autenticazione e protocolli di integrazione per il prodotto SaaS.

Sintassi della richiesta

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

Fornisci informazioni sui campi per aggiungere il tipo di AddDeliveryOptions modifica:

Sintassi di risposta

Viene creato un set di modifiche per la richiesta. La risposta a questa richiesta fornisce l'ID per il set di modifiche ed è simile alla seguente.

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

Convalide sincrone

Errori asincroni

Aggiorna le opzioni di consegna

Puoi utilizzare l'API Catalog per aggiornare le opzioni di consegna per un prodotto SaaS in. Marketplace AWS

Per aggiornare le opzioni di consegna, richiama l'operazione StartChangeSet API con il tipo di UpdateDeliveryOptions modifica, come mostrato nell'esempio seguente.

Sintassi della richiesta

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

Fornisci informazioni sui campi per aggiornare il tipo di UpdateDeliveryOptions modifica con le opzioni di consegna dell'API:

Sintassi della risposta

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS

Convalide sincrone

Errori asincroni

Aggiorna la visibilità delle opzioni di consegna

Puoi utilizzare l'API Catalog per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS. Marketplace AWS

Per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS, chiama StartChangeSet l'operazione API con UpdateDeliveryOptionsVisibility il tipo di modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

Fornisci informazioni sui campi per aggiungere il tipo di UpdateDeliveryOptionsVisibility modifica:

Sintassi della risposta

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS

Convalide sincrone

Errori asincroni

SaaSUrlDeliveryOption

L'esempio seguente mostra come utilizzare SaaSUrlDeliveryOptionDetails per aggiornare ilFulfillmentUrl.

Sintassi della richiesta

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

Fornisci informazioni sui campi in cui aggiungere il tipo di AddDeliveryOptions modifica:

Sintassi della risposta

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS

Convalide sincrone

Errori asincroni

Aggiorna la visibilità delle opzioni di consegna

Puoi utilizzare l'API Catalog per configurare le autorizzazioni in modo che solo alcuni utenti possano modificare la visibilità di un prodotto SaaS. Marketplace AWS

A tale scopo, richiama l'operazione StartChangeSet API con il tipo di UpdateDeliveryOptionsVisibility modifica, come illustrato nell'esempio seguente.

Sintassi della richiesta

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

Fornisci informazioni sui campi per aggiungere il tipo di UpdateDeliveryOptionsVisibility modifica:

Sintassi della risposta

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

La richiesta di modifica viene aggiunta a una coda ed elaborata. Ciò include la convalida delle informazioni per garantire che soddisfino le linee guida. Marketplace AWS Il processo di convalida può richiedere da pochi minuti a qualche ora. Puoi controllare lo stato della richiesta tramite o nell'API Catalog con l'DescribeChangeSetazione. Portale di gestione Marketplace AWS

Convalide sincrone

Errori asincroni