View a markdown version of this page

Usar o AWS Marketplace API Discovery - AWS Marketplace
Endpoint de serviçoVersão da APIModelo de dadosAutenticaçãoFazer solicitações deFormato de respostaUsar o AWS SDKPaginaçãoControle de utilização

A referência da API do AWS Marketplace foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência de API do AWS Marketplace.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usar o AWS Marketplace API Discovery

A API AWS Marketplace Discovery fornece acesso programático ao AWS Marketplace catálogo. Você pode usá-lo para recuperar informações sobre produtos e preços, criar experiências de compras integradas e criar vitrines personalizadas.

Endpoint de serviço

A API Discovery usa o seguinte formato de endpoint:

https://discovery-marketplace.region.api.aws

Por exemplo, para chamar a API no Leste dos EUA (Norte da Virgínia):

https://discovery-marketplace.us-east-1.api.aws

Versão da API

A versão atual da API é2026-02-05.

Modelo de dados

A API Discovery organiza o AWS Marketplace catálogo nas seguintes entidades:

  • Listagem — Um produto ou solução de vários produtos, conforme aparece para os compradores. Uma listagem inclui descrições, destaques, categorias, emblemas, modelos de preços, unidades de preços, avaliações, mídia promocional, contratos com vendedores, tipos de opções de atendimento e referências a produtos e ofertas associados. Use GetListing para recuperar um anúncio ou SearchListings pesquisar anúncios.

  • Produto — O software ou serviço subjacente que está sendo vendido. Um produto inclui descrições, destaques, categorias, mídia promocional, contratos com vendedores e opções de atendimento que descrevem como um comprador pode implantar ou acessar o produto (como AMI, SaaS, Container ou Helm). Use GetProduct para recuperar detalhes do produto e ListFulfillmentOptions recuperar opções detalhadas de atendimento de um produto.

  • Oferta — Um acordo de preços para um produto, incluindo o modelo de preços, o vendedor registrado, as datas de disponibilidade e os emblemas. Uma oferta contém termos comerciais, como preços baseados no uso, preços fixos iniciais, períodos de teste gratuitos, documentos legais, cronogramas de pagamento e condições de renovação. Use ListPurchaseOptions para encontrar todas as ofertas disponíveis de um produto, GetOffer recuperar os detalhes de uma oferta e GetOfferTerms recuperar os termos específicos da oferta.

  • Conjunto de ofertas — Uma coleção agrupada de ofertas privadas para cada produto em uma solução de vários produtos. Um conjunto de ofertas permite que os compradores analisem todas as ofertas em conjunto e as aceitem simultaneamente com uma única ação. Use ListPurchaseOptions para encontrar todos os conjuntos de ofertas disponíveis para um produto, GetOfferSet recuperar os detalhes de um conjunto de ofertas, GetOffer recuperar os detalhes de uma oferta e GetOfferTerms recuperar os termos específicos da oferta.

Autenticação

A API Discovery usa a autenticação padrão AWS Signature Version 4 (SigV4). Você deve ter AWS credenciais válidas e as permissões apropriadas do IAM para chamar a API. Para obter detalhes, consulte Controle de acesso para o AWS Marketplace API Discovery.

Fazer solicitações de

Todas as operações da API Discovery usam o POST método HTTP com um corpo de solicitação JSON. O nome da operação é especificado no caminho do URL.

Formato de resposta

Todas as respostas são retornadas no formato JSON. As respostas bem-sucedidas retornam o código de status HTTP 200. As respostas de erro incluem um tipo de erro e uma mensagem. Para obter detalhes, consulte Erros comuns.

Usar o AWS SDK

A forma recomendada de chamar a API Discovery é por meio do AWS SDK. O SDK processa automaticamente a autenticação, a assinatura de solicitações, a serialização e o tratamento de erros.

# Python (Boto3) example
import boto3

client = boto3.client('marketplace-discovery', region_name='us-east-1')

response = client.get_listing(
    listingId='listing-saas-abc123'
)

print(response['listingName'])
// JavaScript (AWS SDK v3) example
import { MarketplaceDiscoveryClient, GetListingCommand } from "@aws-sdk/client-marketplace-discovery";

const client = new MarketplaceDiscoveryClient({ region: "us-east-1" });
const response = await client.send(new GetListingCommand({
    listingId: "listing-saas-abc123"
}));

console.log(response.listingName);

Paginação

As operações que retornam listas (como ListPurchaseOptions eSearchFacets) suportam o uso de paginação. nextToken Se a resposta incluir um nextToken valor, passe-o na próxima solicitação para recuperar resultados adicionais.

Controle de utilização

A API Discovery impõe limites de taxa de solicitação para garantir a disponibilidade do serviço. Se você exceder o limite de taxa, a API retornará um ThrottlingException (HTTP 429). Implemente a lógica de recuo exponencial e tente novamente em seu aplicativo.