Ambiente de Sandbox de Pedidos
Introdução
O ambiente de sandbox da Open API Magalu para o módulo de Pedidos permite testar a integração com as Apis sem impactar dados reais. Este guia explica como utilizar este ambiente para simular os diversos cenários de fluxo de pedidos, incluindo notas fiscais e etiquetas.
Verifique, no entanto, se a sua aplicação já está configurada para acessar o ambiente de sandbox e já possui os escopos necessários para a API de Pedidos. Veja a seguir quais são:
Escopos necessários
Para a utilização das APIs os seguintes escopos poderão ser necessários:
| Valor | Descrição |
|---|---|
open:order-order-seller:read | Permite a leitura de pedidos e dados relacionados. |
open:order-delivery-seller:read | Permite leitura de informações sobre entregas. |
open:order-delivery-seller:write | Permite alterações em dados de entregas. |
open:order-logistics-seller:read | Permite leitura de informações sobre operações de logística. |
open:order-logistics-seller:write | Permite realizar operações de logística. |
open:order-invoice-seller:read | Permite consultar dados de notas fiscais. |
Comportamento e Uso dos Endpoints
O ambiente Sandbox para o módulo de Pedidos replica o comportamento dos endpoints de Produção na maioria dos casos. A principal diferença no uso está no canal de acesso:
- Para os endpoints que não possuem documentação específica para o Sandbox, o uso é idêntico ao de Produção. Basta utilizar o mesmo método e requisição, alterando apenas o canal para o de Sandbox na sua chamada.
- Para os endpoints que necessitaram de adequação, siga as orientações e exemplos detalhados nas seções seguintes. Eles apresentam diferenças no request ou response quando utilizados neste ambiente e estão devidamente documentados.
Características do Ambiente de Sandbox
Independência de Outros Sistemas
O ambiente de sandbox de Pedidos é completamente isolado dos demais ambientes. Isso significa:
- Dados criados no sandbox Pedidos não afetam outros ambientes
- Validações que dependem de outros sistemas são simuladas
Simulação de Cenários de Erro
O ambiente de sandbox permite simular diversos cenários de erro que podem ocorrer em produção, usando:
- Combinação específica de dados para acionar validações
- Campo
codepara forçar erros específicos que não poderiam ser testados de outra forma
Erros forçados pelo campo code são processados após as validações regulares. Portanto, se sua requisição contiver erros de validação comuns, esses serão sinalizados primeiro, independente do valor de code.