<"-- -->

Sandbox

Antes de iniciar a execução da sua aplicação em ambiente de Produção, é de extrema importância que você consiga testar suas funcionalidades para assegurar-se de que irá operar livre de erros. Além de certificar-se de que ela cumpra todas as regras definidas pelo uso das APIs.

Para auxiliá-lo nos testes, oferecemos o ambiente de Sandbox, modelado especialmente para a execução de testes com as APIs. O ambiente de Sandbox é exclusivo para a API V2. Para utilização da API V3 e V4 será necessário utilização de um ambiente dedicado a tal ação, que é denominado Ambiente de Produção (que funcionará normalmente com sua chave de Sandbox), porém é importante salientar que tais execuções não refletirão de fato na base de Produção do lojista.

Para estes testes, pode-se executar todas as operações que executa em ambiente de produção, porém, todas as informações são fictícias, não havendo acesso algum às informações de Produção de fato. O contrário também é verdadeiro, informações de produção não podem ser vistas em ambiente de testes.

Obtenção do Access Token em Sandbox

Para obter a chave de acesso de Sandbox, é necessário seguir alguns passos. Acesse a documentação 'Como Iniciar' para o processo de geração da chave de acesso e a documentação 'Autenticação' para melhor compreensão do processo de utilização.

Fazendo chamadas para as APIs

Uma vez obtido o Token de Sandbox, a aplicação opera de forma idêntica ao ambiente de produção. A principal diferença é que a aplicação deve apontar para o ambiente de Sandbox ao invés de Produção.

URL de Sandbox:

https://sandbox-mktplace.viavarejo.com.br/api/v2/

URL de Produção:

API V2:
https://api-mktplace.viavarejo.com.br/api/v2/

API V3:
https://api-mktplace.viavarejo.com.br/api/v4/api-front-importer-v3/jersey/

API V4:
https://api-mktplace.viavarejo.com.br/api/v4/api-front-importer-v4/jersey/

 

APIs exclusivas para Sandbox

Para auxiliar no fluxo de testes, disponibilizamos dois endpoints exclusivos no ambiente de Sandbox, para prosseguirem com o desenvolvimento completo da aplicação. São eles:

POST /orders

*Utilizado para criação de pedido

PUT /orders/status/approved/{orderId}

*Utilizado para atualizar o status do pedido criado para "pagamento aprovado".

Lembrando que em produção, a criação de um pedido acontece diretamente no site, no entanto, em Sandbox, é preciso criar um pedido para poder consultá-lo e validar a consulta de pedidos novos, também é preciso simular a aprovação de pagamento de um pedido para validar a consulta de pedidos aprovados.

Clique aqui e consulte o swagger das APIs.

Importante: No swagger, os endpoints mencionados estarão destacados com a informação (SANDBOX).

Português, Brasil