O que é o Amazon Seller API Sandbox e como usá-lo?
Se você é um vendedor da Amazon que deseja automatizar e otimizar seus processos de negócios, pode estar interessado em usar a API do Amazon Seller. A Amazon Seller API, ou SP-API para abreviar, é um serviço da Web baseado em REST que permite acessar vários recursos e dados relacionados à sua conta de vendedor, como pedidos, estoque, relatórios, notificações e muito mais.
amazon seller api sandbox
No entanto, antes de começar a usar o SP-API em seu ambiente de produção, você pode querer testar seus aplicativos sem afetar seus dados reais ou acionar eventos do mundo real. É aqui que o ambiente sandbox é útil. O ambiente sandbox é uma versão simulada do ambiente de produção que permite fazer chamadas de teste para o SP-API sem quaisquer consequências.
A SP-API fornece dois tipos de ambientes de sandbox: estático e dinâmico. A caixa de proteção estática usa correspondência de padrão para retornar respostas estáticas simuladas para todas as SP-APIs. O sandbox dinâmico encaminha solicitações para um back-end de sandbox que pode retornar respostas realistas com base nos parâmetros de solicitação. Neste artigo, explicaremos como usar os dois tipos de ambientes sandbox e quais são seus benefÃcios e limitações.
Sandbox estático da API do parceiro de vendas
A caixa de proteção estática da API do parceiro de vendas (caixa de proteção estática) é idêntica ao ambiente de produção, exceto pelo fato de você direcionar as chamadas para os pontos de extremidade da caixa de proteção em vez dos pontos de extremidade de produção. Chamar os endpoints de sandbox retorna respostas estáticas e simuladas para todas as SP-APIs. Você pode consultar essas respostas simuladas no arquivo JSON do modelo Swagger para cada API que deseja chamar.
A caixa de proteção estática funciona como muitas estruturas simuladas, pois usa correspondência de padrão para retornar uma resposta especificada quando os parâmetros especificados estão presentes.Por exemplo, se você enviar uma solicitação que inclua um determinado ID de pedido, receberá uma resposta que contém informações sobre esse ID de pedido. No entanto, essas respostas não são baseadas em seus dados reais, mas sim em dados predefinidos que são armazenados no arquivo JSON.
Para fazer uma chamada de sandbox estática para uma SP-API, você precisa fazer duas coisas: verificar o arquivo JSON para obter os parâmetros de solicitação e fazer uma chamada com esses parâmetros. Aqui está um exemplo de como fazer isso:
Verifique o arquivo JSON para obter os parâmetros de solicitação. Vá para . Abra a pasta para a API que você deseja fazer uma chamada de sandbox. Clique no arquivo JSON do modelo Swagger para essa API. Procure um objeto x-amzn-api-sandbox que contenha uma matriz "estática". Este objeto conterá exemplos de solicitação e resposta para chamadas estáticas de sandbox para a operação da API na qual elas aparecem. Se o exemplo de solicitação contiver parâmetros, use-os na próxima etapa.
Faça uma chamada de sandbox estática para uma API. Faça uma chamada da mesma forma que faria uma chamada de produção, com estas diferenças:
Inclua os parâmetros da Etapa 1.
Adicione um cabeçalho x-amzn-sandbox com o valor "true" em sua solicitação.
Use um destes URLs base, dependendo da sua região:
RegiãoURL base
América do Norte
Europa
Extremo Oriente
Por exemplo, para fazer uma chamada de sandbox estática para a operação getOrders da API Orders, você pode usar a seguinte solicitação:
GET x-amzn-sandbox: true Autorização: Portador AtzaIQEBLjAsAhRmHjNgHpi0U-Dme 37rR6CuUpS... x-amzn-RequestId: 12345678-1234-1234-1234-123456789012 Host: sandbox.sellingpartnerapi-na.amazon.com User-Agent: MySellingPartnerApp/1.0 (Language=Java/1.8.0_121; Platform=Windows/10)
A resposta será uma resposta estática e simulada que contém informações sobre os pedidos que correspondem aos parâmetros da solicitação. Você pode comparar a resposta com o exemplo de resposta no arquivo JSON para verificar se está correto.
Sandbox dinâmico da API do parceiro de vendas
A caixa de proteção dinâmica da API do parceiro de vendas (caixa de proteção dinâmica) é diferente do ambiente de produção porque encaminha as solicitações para um back-end de caixa de proteção que pode retornar respostas realistas com base nos parâmetros da solicitação. A sandbox dinâmica não usa seus dados reais, mas gera dados em tempo real com base em regras e lógica predefinidas. A sandbox dinâmica também não aciona nenhum evento do mundo real, como envio de notificações ou atualização de inventário.
O sandbox dinâmico é útil para testar cenários que não são cobertos pelo sandbox estático, como tratamento de erros, paginação, limitação e lógica de negócios complexa. O sandbox dinâmico também permite testar algumas APIs e operações que não são suportadas pelo sandbox estático, como a API de feeds e a API de relatórios.
Para fazer uma chamada de sandbox dinâmica para uma SP-API, você precisa fazer duas coisas: verificar o arquivo JSON para obter os parâmetros de solicitação e fazer uma chamada com esses parâmetros. Aqui está um exemplo de como fazer isso:
Verifique o arquivo JSON para obter os parâmetros de solicitação. Vá para . Abra a pasta para a API que você deseja fazer uma chamada de sandbox. Clique no arquivo JSON do modelo Swagger para essa API. Procure um objeto x-amzn-api-sandbox que contenha uma matriz "dinâmica". Este objeto conterá exemplos de solicitação e resposta para chamadas dinâmicas de sandbox para a operação da API na qual elas aparecem. Se o exemplo de solicitação contiver parâmetros, use-os na próxima etapa.
Faça uma chamada de sandbox dinâmica para uma API. Faça uma chamada da mesma forma que faria uma chamada de produção, com estas diferenças:
Inclua os parâmetros da Etapa 1.
Adicione um cabeçalho x-amzn-sandbox com o valor "true" em sua solicitação.
Use um destes URLs base, dependendo da sua região:
RegiãoURL base
América do Norte
Europa
Extremo Oriente
Por exemplo, para fazer uma chamada de sandbox dinâmica para a operação createFeedDocument da API de feeds, você pode usar a seguinte solicitação:
POST x-amzn-sandbox: true Autorização: Portador AtzaIQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpS... x-amzn-RequestId: 12345678-1234-1234-1234- 123456789012 Host: sandbox.sellingpartnerapi-na.amazon.com User-Agent: MySellingPartnerApp/1.0 (Language=Java/1.8.0_121; Platform=Windows/10) Content-Type: application/json "contentType": "text/tab-separated-values; charset=UTF-8"
A resposta será uma resposta dinâmica e realista que contém informações sobre o documento de alimentação que foi criado. Você pode comparar a resposta com o exemplo de resposta no arquivo JSON para verificar se está correto.
Conclusão
O ambiente sandbox da Amazon Seller API é uma ótima ferramenta para testar seus aplicativos e integrações sem afetar seus dados reais ou acionar eventos do mundo real. O ambiente sandbox oferece dois tipos de simulações: estática e dinâmica. A caixa de proteção estática retorna respostas estáticas simuladas para todas as SP-APIs com base na correspondência de padrões. A sandbox dinâmica retorna respostas realistas com base nos parâmetros de solicitação e regras e lógica predefinidas.
Aqui estão algumas dicas e práticas recomendadas para usar o ambiente sandbox:
Use a caixa de proteção estática para testar a funcionalidade básica e a validação de seus aplicativos.
Use a sandbox dinâmica para testar cenários complexos e tratamento de erros de seus aplicativos.
Verifique o arquivo JSON para cada API que você deseja fazer uma chamada de sandbox para localizar os parâmetros de solicitação e exemplos de resposta.
Adicione um cabeçalho x-amzn-sandbox com o valor "true" em sua solicitação para indicar que você está fazendo uma chamada de sandbox.
Use o URL base apropriado para sua região ao fazer uma chamada de sandbox.
Consulte o para obter mais informações e orientações sobre como usar o ambiente sandbox.
Esperamos que este artigo tenha ajudado você a entender o que é o sandbox da Amazon Seller API e como usá-lo. Se você está pronto para experimentar o ambiente sandbox, pode se inscrever para uma conta de desenvolvedor gratuita . Teste feliz!
perguntas frequentes
Qual é a diferença entre Amazon Seller API e Amazon MWS?
Amazon Seller API (SP-API) é a próxima geração do Amazon Marketplace Web Service (MWS). O SP-API oferece mais recursos, melhor desempenho e segurança aprimorada do que o MWS. O SP-API também usa serviços da Web RESTful em vez de serviços da Web baseados em SOAP, o que facilita a integração com outros sistemas e plataformas.
Como obtenho acesso à Amazon Seller API?
Para obter acesso à Amazon Seller API, você precisa ter uma conta de vendedor da Amazon e uma conta de desenvolvedor. Você pode se registrar para uma conta de desenvolvedor .
Como monitoro meu uso da Amazon Seller API?
Você pode monitorar seu uso da Amazon Seller API usando a Selling Partner API para relatórios de uso. Essa API permite que você obtenha informações sobre sua utilização de cota, detalhes de limitação e status de integridade do serviço. Você também pode usar o Selling Partner API for Notifications para receber notificações sobre alterações de cota, eventos de limitação e problemas de serviço.
Como soluciono erros ao usar a API Amazon Seller?
Você pode solucionar erros ao usar a API Amazon Seller verificando os códigos de erro e as mensagens que são retornadas na resposta. Você também pode consultar o para cenários e soluções de erros comuns.
Como obtenho suporte ao usar a API Amazon Seller?
Você pode obter suporte ao usar a Amazon Seller API entrando em contato com a equipe de suporte ao desenvolvedor da API do parceiro de vendas. Você pode enviar um caso de suporte para interagir com outros desenvolvedores e obter respostas para suas perguntas. 0517a86e26