Tutorial: testar os endpoints da API do parceiro de vendas

Use o sandbox para fazer chamadas de teste sem afetar os dados de produção.

A API do parceiro de vendas (SP-API) fornece ambientes sandbox onde você pode testar os endpoints da API SP-sem afetar os dados de produção. Você pode direcionar chamadas para os endpoints de sandbox do SP-API para fazer solicitações estáticas que retornam respostas simuladas. Ao usar o sandbox, você pode praticar as etapas necessárias para fazer uma chamada, entender os formatos de solicitação e resposta, praticar a validação das credenciais do aplicativo e brincar com os endpoints da API sem afetar os dados de produção.

Tutorial

O tutorial a seguir demonstra como gerar os tokens de acesso necessários e fazer chamadas para os endpoints de sandbox da SP-API.

Pré-requisitos

Para concluir este tutorial, você precisa dos seguintes pré-requisitos:

  • Uma conta e um espaço de trabalho do Postman. Para obter mais informações sobre como usar o Postman, consulte Usando o Postman para vender modelos de API de parceiros.
  • Se você tiver sua própria conta de parceiro de vendas, você pode autoautorizar seu aplicativo para acessar as informações da sua conta.
  • Se você não tiver sua própria conta de parceiro de vendas, deverá configurar uma fluxo de trabalho OAuth de terceiros. Com esse fluxo de trabalho, vendedores e fornecedores terceirizados podem autorizar seu aplicativo a acessar os dados do Amazon Selling Partner.

Durante esse processo, você recebe um token de atualização que pode ser trocado posteriormente por um token de acesso. É necessário um token de acesso para chamar os endpoints da SP-API.

Variáveis necessárias para realizar testes com o Postman

Para fazer chamadas com o Postman, você deve primeiro configurar as credenciais. Você precisará das seguintes variáveis globais para seu espaço de trabalho:

Fluxo de trabalho passo a passo

Você pode usar as etapas a seguir para testar um endpoint da API do parceiro de vendas:

Etapa 1. Gere um login com o token de acesso da Amazon (LWA)

Primeiro, você precisa autorizar seu aplicativo a acessar dados de vendas em nome de um parceiro de vendas. Quando você gera um token de acesso Login with Amazon (LWA), ele pode ser usado para várias chamadas da SP-API até expirar.

Para obter etapas detalhadas, consulte Gere um token de acesso LWA usando o Postman ou Etapa 1. Solicite um login com o token de acesso da Amazon.

A resposta retorna um Token de acesso LWA que você pode usar para autenticar sua chamada SP-API. Um token de acesso LWA deve ser incluído nas chamadas para todas as operações (exceto operações restritas) que retornam informações de identificação pessoal (PII). Ao chamar operações restritas, você inclui um token de acesso restrito (RDT) em vez de um token de acesso LWA

A imagem a seguir mostra um exemplo em que o token de acesso é iniciado Atza|**************************** e expira em (o número de segundos antes que o token de acesso LWA se torne inválido) 3600 segundos (1 hora).

2034

Solicitação e resposta do token de acesso LWA

Etapa 2. Faça uma chamada para o endpoint de sandbox do SP-API

As etapas a seguir abordam como praticar a realização de uma chamada para o endpoint sandbox da SP-API usando o modelo Swagger da API Orders. Você pode usar esse processo para testar chamadas de API e examinar solicitações e respostas simuladas.

  1. Importe o API de pedidos Modelo Swagger para seu espaço de trabalho Postman.
  2. Pesquise o código por um x-amzn-api-sandbox objeto que contém uma matriz estática de exemplos de solicitações e respostas para chamadas estáticas de sandbox para a operação de API na qual elas aparecem.
  3. Defina os parâmetros da solicitação com os mesmos valores que o modelo Swagger da API Orders define.
  4. Verifique se sua solicitação inclui todos os parâmetros necessários, conforme definido no modelo Swagger correspondente. O exemplo a seguir mostra um API de pedidos v0 Modelo Swagger, onde Get Order A chamada de API é destacada com uma resposta bem-sucedida:
2148

Solicita o modelo Swagger da API v0

  1. Faça um GET Ligue para /orders/v0/orders.
  2. Defina o baseUrl como Sandbox da API do parceiro de vendas.
  3. Sob o Parâmetros tab, passe os valores estáticos da solicitação do modelo da API Orders.
2704

Valores de solicitação estática na guia Parâmetros

  1. Sob o Cabeçalhos aba, passe o access_token recebido em Etapa 1 para cada chamada de API, usando o par de valores-chave x-amz-access-token: Atc|********************. Ignore esta etapa para operações restritas e operações sem subsídios.
2720

Token de acesso na guia Cabeçalhos

  1. Para operações restritas, passe o Token de Dados Restritos (RDT) recebido do createRestrictedDataToken operações usando o par de valores-chave x-amz-access-token: Atz.sprdt|********************.

🚧

Importante

Se você estiver ligando para uma operação restrita para acessar as Informações de Identificação Pessoal (PII) de um cliente, como informações do comprador ou um endereço de entrega, passe um Token de dados restritos (RDT) nos cabeçalhos da solicitação em vez de um Token de acesso LWA. Você pode ligar para o Criar um token de dados restrito operação em API de tokens para obter um Token de dados restritos (RDT) para um ou mais recursos restritos que você especificar.

O exemplo de resposta a seguir retorna um RDT e seu tempo de expiração. O token RDT pode ser usado no Get Orders operação para recuperar dados de PII.

2708

Resposta do token de dados restrito e tempo de expiração

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }

  1. Verifique se a resposta retorna uma carga que corresponda ao modelo Swagger.
2698

Obtenha a resposta estática da API Orders v0 usando o token de acesso

Use a sandbox dinâmica da Selling Partner API para fazer solicitações com status

O SP-API também fornece uma sandbox dinâmico onde você pode fazer solicitações e receber respostas variadas que são potencialmente dinâmicas e que reagem às entradas.

Você pode determinar quais operações permitem chamadas de sandbox dinâmicas revisando o JSON do modelo de Swagger para a API que deseja chamar. Uma operação permitirá chamadas para o sandbox dinâmico se ela incluir o seguinte objeto:

"x-amzn-api-sandbox": { "dynamic": {} }

O objeto pode ser encontrado no nível da operação ou do caminho. Quando no nível do caminho, todas as operações dentro do caminho podem fazer chamadas para o sandbox dinâmico.

Para obter mais detalhes sobre como fazer chamadas para a sandbox dinâmica, consulte Como fazer uma chamada dinâmica de sandbox para a API do parceiro de vendas.

Conclusão

Neste tutorial, você aprendeu a testar seus endpoints de sandbox da SP-API. No passo a passo, você gerou um token de acesso LWA e explorou exemplos de chamadas da SP-API para os endpoints do sandbox.


Esta página ajudou você?