Pular para o conteúdo principal

Como usar o ambiente de Sandbox

O sandbox da Open API Magalu é um ambiente seguro e isolado, ideal para testar aplicações, integrações e configurações sem impactar os sistemas reais de produção.

Cada marketplace (como Magalu, Netshoes, KaBuM!, entre outros) possui seu próprio canal de sandbox, com um identificador exclusivo. Isso permite simular interações específicas para cada ecossistema, garantindo maior fidelidade nos testes.

Identificadores dos canais de sandbox disponíveis:

  • Magalu: 5f62650a-0039-4d65-9b96-266d498c03bd

(Outros canais serão disponibilizados conforme evolução do ambiente.)

Como se conectar a um canal de sandbox?​​

Cliente da aplicação​

A integradora ou seller deve criar seu client conforme as instruções disponíveis na documentação oficial. Também é possível utilizar um client já existente, se necessário.

Audência de sandbox​

Para se conectar ao ambiente de sandbox, o client deve estar configurado com a audiência correspondente: https://api-sandbox.magalu.com .

Se a audiência ainda não estiver incluída, atualize o client com o seguinte comando:

idm client update --uuid "<uuid do client>" --audience "https://api.magalu.com https://api-sandbox.magalu.com https://services.magalu.com"

Consentimento​

Para obter o consentimento, é necessário realizar o fluxo de autenticação descrito na documentação: Autenticação e autorização | Magalu Devs.

info

Nota: O tenant utilizado no fluxo de consentimento pode ser qualquer um — inclusive uma conta pessoa física da integradora.

Onboarding no Ambiente de Sandbox​

Este passo é essencial para associar um seller fictício ao seu tenant no canal de sandbox.

Durante esse processo, certifique-se de utilizar sempre o channel_id correspondente ao ambiente de testes.

Exemplo de requisição:

curl --request PUT \
  --url https://api-sandbox.magalu.com/v1/samples/onboarding \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "channel_id": "5f62650a-0039-4d65-9b96-266d498c03bd"
  }'

Exemplo de resposta:

{
  "seller_id": "GENPUB.cd994404-973a-4fe1-9089-46fad31073a5",
  "seller_alias": "sandbox_cd994404-973a-4fe1-9089-46fad31073a5",
  "channel_id": "5f62650a-0039-4d65-9b96-266d498c03bd",
  "channel_alias": "sandbox-1"
}

Uso das APIs no Sandbox​

Após a finalização do onboarding, será possível obter o token de acesso e realizar chamadas às APIs conforme a documentação oficial. Sendo:

atenção

  • O ambiente de sandbox está sendo disponibilizado gradualmente, por módulos. Verifique no menu da documentação quais recursos estão ativos e acompanhe atualizações (novos endpoints, funcionalidades, etc.).

  • Como este é um ambiente de homologação, os dados são limpos automaticamente a cada 3 (três) meses, contados a partir do início de uso.

  • Em caso de dúvidas ou suporte, entre em contato com a equipe responsável.