Utilizando o Simulador Online

Através de nosso simulador você pode testar todos os métodos:

Swagger UIapi.toplojas.com.br

Configurando o Token e o Identificador da Loja

Antes de começar a utilizar, clique em "Authorize":

Preencha seu "Token" e o "Identificador da Loja" conforme os dados obtidos em:

Geração de Token

Exemplo:

Após, clique nos DOIS botões de "Authorize":

Após isto, o botão ira sumir e será exibido o botão , exemplo:

Pronto! Feche a janela através do "X" no canto direito superior e comece a testar a API.

Chamando o endpoint "/status/"

Para testarmos o funcionamento, iremos acionar o endpoint "/status/", para isto, localizei a seção "Outros -> Status" e clique na linha azul:

Após isto, o sistema ira exibir quais os parâmetros que podem ser enviados, o que pode (ou deve) ser enviado no body da requisição e qual o retorno esperado.

Clique em "Try in Out" e após em "Execute":

Após isto, será exibido alguns detalhes muito importantes:

• A requisição CURL completa

• A url completa chamada

• A resposta do servidor

Exemplo:

Observe também, que existe uma área "Responses", onde o sistema mostra cada campo que pode ser retornado e exemplos de retorno.

Quais dados devem ser enviados

Ao abrir um dos métodos, o sistema exibe um exemplo dos campos que devem ser enviados no body da requisição.

Em alguns métodos, existem mais exemplos para o mesmo método, para isto, clique no campo ao lado de "Examples":

Junto ao exemplo de dados, temos a referência de cada campo que pode ser enviado e seus requisitos, para isto, clique em "Schema":

Neste espaço é exibido todos os campos, exemplo de como devem ser preenchidos, quais são obrigatórios e os tipos de informações esperados.

Quais dados devem ser recebidos

Ao abrir um dos métodos, no espaço "Responses", o sistema exibe um exemplo dos dados que são retornados:

Em alguns métodos, existem mais exemplos para o mesmo método, para isto, clique no campo ao lado de "Examples":

Junto ao exemplo de dados, temos a referência de cada campo que pode ser retornado e seus requisitos, para isto, clique em "Schema":

Neste espaço é exibido todos os campos que podem ser retornados, os valores possíveis e os tipos de dados que serão retornados.