Sandbox da API do parceiro de vendas
Use a sandbox SP-API para fazer chamadas de teste.
A API do parceiro de vendas fornece dois ambientes de sanbox que permitem testar seus aplicativos sem afetar os dados de produção nem acionar eventos reais. O sandbox estático da API do parceiro de vendas usa correspondência de padrões para retornar respostas estáticas simuladas. O sandbox dinâmico da API do parceiro de vendas encaminha as solicitações para um back-end de sandbox que pode retornar respostas realistas com base nos parâmetros da solicitação.
Importante
os ambientes de sandbox são projetados para testar a funcionalidade, não a escalabilidade. As chamadas para endpoints de sandbox estão sujeitas a estas limitações: taxa = 5 solicitações por segundo; pico = 15. Para obter mais informações sobre limitação, consulte Planos de uso e limites de taxa na API do parceiro de vendas.
Se estiver usando um ambiente de sandbox da SP-API para testar uma chamada que requer um token de dados restritos (RDT), você deve obter o RDT do ambiente de produção e passá-lo para sua chamada de sandbox. Mais informações sobre operações restritas para as quais um RDT é necessário podem ser encontradas aqui.
Conteúdo
O sandbox estático da API do parceiro de vendas
Fazer chamadas de sandbox para o sandbox estático da API do parceiro de vendas é o mesmo que fazer chamadas de produção, exceto que você direciona as chamadas para os endpoints de sandbox da API do parceiro de vendas. Chamar os endpoints de sandbox retorna respostas estáticas simuladas para todas as APIs do parceiro de vendas. Você pode consultar essas respostas simuladas no arquivo JSON do modelo de Swagger para a API que deseja chamar. Para obter mais informações, consulte Como fazer uma chamada de sandbox estática para a API do parceiro de vendas.
O sandbox estático da API do parceiro de vendas funciona como muitas estruturas de simulação, pois usa a correspondência de padrões para retornar uma resposta especificada quando os parâmetros especificados estão presentes. Um desenvolvedor recebe uma resposta definida em um dos objetos a seguir quando envia uma solicitação que inclui os parâmetros especificados:
Objetos JSON estáticos de sandbox
"x-amzn-api-sandbox":
{
"static": [
{
"request":
{
"parameters":
{
…
}
},
"response":
{
…
}
}
]
}
Embora esses objetos contenham os parâmetros necessários para corresponder a uma resposta simulada, eles não necessariamente contêm todos os parâmetros necessários para uma resposta bem-sucedida. Para obter uma resposta bem-sucedida, certifique-se de que sua solicitação seja válida e inclua todos os parâmetros necessários conforme definido no modelo de Swagger correspondente.
Como fazer uma chamada de sandbox estática para a API do parceiro de vendas
Etapa 1. Procurar no arquivo JSON por parâmetros de solicitação
-
Acesse a página Documentação.
-
No painel de navegação esquerdo, localize a pasta da API para a qual você deseja fazer uma chamada de sandbox.
-
Escolha o arquivo JSON do modelo de Swagger da API que você deseja.
O código JSON é exibido.
-
Pesquise o código de um objeto
x-amzn-api-sandbox
que contém uma matriz de"static"
.
Os objetos JSON de sandbox estáticos conterão exemplos de solicitações e respostas para chamadas de sandbox estáticas para a operação de API na qual eles aparecem. Se o exemplo da solicitação contiver parâmetros, use-os na etapa a seguir.
Etapa 2. Fazer uma chamada de sandbox estática a uma API
Faça uma chamada de sandbox estática a uma API da mesma forma que faria uma chamada de produção, com estas diferenças:
-
Inclua os parâmetros da Etapa 1. Procurar no arquivo JSON por parâmetros de solicitação em sua chamada. Se a API exigir parâmetros além desses, não se esqueça de incluir os obrigatórios em sua chamada.
-
Direcione sua chamada para um dos endpoints de sandbox da API do parceiro de vendas.
Você deve receber uma resposta que corresponda ao objeto de payload contido no objeto JSON estático de sandbox da Etapa 1.
O sandbox dinâmico da API do parceiro de vendas
Fazer chamadas para o sandbox dinâmico da API do parceiro de vendas é o mesmo que fazer chamadas de produção, exceto que você direciona as chamadas para os endpoints de sandbox da API do parceiro de vendas. As chamadas de sandbox dinâmicas são enviadas por proxy (ou seja, encaminhadas) para um back-end de sandbox, que retorna uma resposta apropriada de acordo com os parâmetros da solicitação. Como você não está limitado à correspondência exata de padrões, pode fazer solicitações e receber respostas potencialmente com estado e que reajam às entradas. Por exemplo, talvez você queira verificar as despesas de envio para diferentes endereços de entrega. O que pode ser feito é limitado apenas pelos recursos suportados pelo back-end de sandbox fornecido para essa seção de API.
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.
Como fazer uma chamada dinâmica de sandbox à API do parceiro de vendas
Etapa 1. Procurar no arquivo JSON por operações que permitem chamadas de sandbox dinâmicas
-
Acesse a página Documentação.
-
No painel de navegação esquerdo, localize a pasta da API para a qual você deseja fazer uma chamada de sandbox.
-
Escolha o arquivo JSON do modelo de Swagger da API que você deseja.
O código JSON é exibido.
-
Pesquise no código o seguinte:
"x-amzn-api-sandbox":
{
"dynamic": {}
}
Se a operação contiver o objeto no nível do caminho ou da operação, o sandbox dinâmico será suportado.
Etapa 2. Fazer uma chamada de sandbox dinâmica a uma API
Faça uma chamada de sandbox dinâmica a uma API da mesma forma que faria uma chamada de produção, mas direcione sua chamada para um dos endpoints de sandbox da API do parceiro de vendas.
Operações exclusivas do sandbox
Os ambientes de sandbox permitem APIs opcionais que são exclusivas do sandbox e só podem ser bem-sucedidas quando direcionadas a um dos endpoints de sandbox da API do parceiro de vendas. Você pode determinar quais operações são exclusivas do sandbox revisando o JSON do modelo de Swagger para a seção da API. Uma operação que é exclusiva do sandbox contém "x-amzn-api-sandbox-only": true
no nível da operação ou do caminho. Quando no nível do caminho, todas as operações no caminho são exclusivas do sandbox.
As operações exclusivas do sandbox complementam a API de produção para que você possa criar fluxos de trabalho de teste que não são possíveis usando as operações da API de produção. Por exemplo, você pode ter um caso de uso em que um item de dados é instanciado por meio da interface do usuário, mas não por meio de uma API. Somente para fins de teste, uma API exclusiva do sandbox pode ser fornecida para criar o item de dados a fim de permitir fluxos de trabalho de teste mais completos.
Endpoints de sandbox da API do parceiro de vendas
A API do parceiro de vendas tem endpoints de sandbox para as regiões de vendas da América do Norte, Europa e Extremo Oriente.
Região de vendas | Endpoint | Região da AWS |
---|---|---|
América do Norte (marketplaces do Canadá, EUA, México e Brasil) | https://sandbox.sellingpartnerapi-na.amazon.com | us-east-1 |
Europa (marketplaces da Espanha, Reino Unido, França, Holanda, Alemanha, Itália, Suécia, Polônia, Egito, Turquia, Emirados Árabes Unidos e Índia) | https://sandbox.sellingpartnerapi-eu.amazon.com | eu-west-1 |
Extremo Oriente (marketplaces de Singapura, Austrália e Japão) | https://sandbox.sellingpartnerapi-fe.amazon.com | us-west-2 |
Updated 23 days ago