Se reestructuró la referencia de la API de AWS Marketplace. Para obtener más información sobre las operaciones de API compatibles, consulte la referencia de API de AWS Marketplace.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabaje con productos SaaS mediante AWS Marketplace API

Puede utilizarlas AWS Marketplace Catalog API para automatizar las tareas relacionadas con el trabajo con SaaS-based productos. Para obtener información sobre la creación de SaaS-based productos, consulteCree un producto. En los siguientes temas se describe cómo realizar las acciones de la API de catálogo:

Configure el modelo de precios gratuito para los productos SaaS

Los productos SaaS se pueden ofrecer con un modelo de precios gratuito, que permite a los compradores utilizar su producto sin coste alguno. Cuando utilices el modelo de precios gratuito para los productos de SaaS, debes configurar las dimensiones de los precios con precios de cero dólares en uno o dos. UsageBasedPricingTerm ConfigurableUpfrontPricingTerm

Para configurar los precios gratuitos de un producto SaaS:

Al configurar la oferta, asegúrese de que:

Opciones de lanzamiento rápido de SaaS

Para obtener información sobre las opciones de inicio rápido, consulte los siguientes recursos:

Añade opciones de entrega

Puede usar la API de catálogo para agregar opciones de entrega para un producto SaaS en AWS Marketplace. Las opciones de entrega de la API permiten a los vendedores ofrecer API-based servicios que se integran con AWS servicios como Amazon Bedrock para los flujos de trabajo de los agentes de IA.

Para añadir las opciones de entrega de la API, llama a la operación de la StartChangeSet API con el tipo de AddDeliveryOptions cambio para añadir los detalles de entrega, como se muestra en el siguiente ejemplo.

En los siguientes temas se explica cómo agregar y usar las SaaSUrlDeliveryOptionDetails opciones ApiDeliveryOptionDetails y.

ApiDeliveryOptionDetails

El ejemplo de esta sección admite el tipo de opción de ApiDeliveryOptionDetails entrega, que le permite especificar los puntos finales de la API, los métodos de autenticación y los protocolos de integración para su producto SaaS.

Sintaxis de la solicitud

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

Proporcione información sobre los campos para agregar el tipo de AddDeliveryOptions cambio:

Sintaxis de respuesta

Se crea un conjunto de cambios para su solicitud. La respuesta a esta solicitud le proporciona el identificador del conjunto de cambios y tiene el siguiente aspecto.

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

Validaciones sincrónicas

Errores asincrónicos

Actualice las opciones de entrega

Puedes usar la API de catálogo para actualizar las opciones de entrega de un producto SaaS en AWS Marketplace.

Para actualizar las opciones de entrega, llama a la operación de la StartChangeSet API con el tipo de UpdateDeliveryOptions cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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

Proporciona información en los campos para actualizar el tipo de UpdateDeliveryOptions cambio con las opciones de entrega de la API:

Sintaxis de respuesta

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluye la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas. Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o en la API de catálogo con la DescribeChangeSet acción.

Validaciones sincrónicas

Errores asincrónicos

Actualizar la visibilidad de las opciones de entrega

Puede usar la API de catálogo para configurar los permisos de modo que solo algunos usuarios puedan cambiar la visibilidad de un producto SaaS en AWS Marketplace.

Para configurar los permisos de modo que solo algunos usuarios puedan cambiar la visibilidad de un producto de SaaS, llame a la operación de la StartChangeSet API con el tipo de UpdateDeliveryOptionsVisibility cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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

Proporcione información para los campos para agregar el tipo de UpdateDeliveryOptionsVisibility cambio:

Sintaxis de respuesta

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluye la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas. Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o en la API de catálogo con la DescribeChangeSet acción.

Validaciones sincrónicas

Errores asincrónicos

SaaSUrlDeliveryOption

El siguiente ejemplo muestra cómo usar SaaSUrlDeliveryOptionDetails para actualizar elFulfillmentUrl.

Sintaxis de la solicitud

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

Proporcione información sobre los campos para agregar el tipo de AddDeliveryOptions cambio:

Sintaxis de respuesta

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluye la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas. Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o en la API de catálogo con la DescribeChangeSet acción.

Validaciones sincrónicas

Errores asincrónicos

Actualiza la visibilidad de las opciones de entrega

Puede usar la API de catálogo para configurar los permisos de modo que solo algunos usuarios puedan cambiar la visibilidad de un producto SaaS en AWS Marketplace.

Para ello, llame a la operación de la StartChangeSet API con el tipo de UpdateDeliveryOptionsVisibility cambio, como se muestra en el siguiente ejemplo.

Sintaxis de la solicitud

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

Proporcione información para los campos para agregar el tipo de UpdateDeliveryOptionsVisibility cambio:

Sintaxis de respuesta

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

La solicitud de cambio se agrega a una cola y se procesa. Esto incluye la validación de la información para garantizar que cumple con las AWS Marketplace directrices. El proceso de validación puede tardar desde unos minutos hasta unas horas. Puedes comprobar el estado de la solicitud a través de la AWS Marketplace Management Portal API de catálogo o en la API de catálogo con la DescribeChangeSet acción.

Validaciones sincrónicas

Errores asincrónicos