Configurando o Postman

O Postman é um dos programas mais usados para testar APIs. Como nossa API é publicada em OpenAPI 3.0, você pode importar todos os métodos de uma vez a partir do nosso arquivo doc.json — sem precisar cadastrar cada requisição manualmente.

Não tem o Postman? Baixe gratuitamente em https://www.postman.com/downloads/.

📥 Importando o doc.json

Você pode importar diretamente pela URL do contrato (recomendado, pois sempre traz a versão mais recente) ou baixando o arquivo.

Opção 1 — Importar pela URL

1. No Postman, clique em Import (canto superior esquerdo).

2. Selecione a aba Link.

3. Cole a URL do nosso doc.json:

https://api.toplojas.com.br/doc/doc.json

1. Clique em Continue e depois em Import.

Opção 2 — Importar o arquivo baixado

1. Baixe o arquivo doc.json:

https://api.toplojas.com.br/doc/doc.jsonapi.toplojas.com.br

1. No Postman, clique em Import e arraste o arquivo (ou selecione-o pelo botão files).

Ao final, o Postman cria uma Collection chamada Toplojas, já com todos os endpoints organizados por módulo (Pedidos, Produtos, Clientes, etc.).

🔑 Configurando a autenticação

Todas as requisições precisam dos headers de autenticação. Em vez de preenchê-los em cada requisição, configure-os uma única vez na Collection usando variáveis.

Se ainda não tem o Token e o Identificador da Loja, obtenha-os aqui:

Geração de Token

Passo 1 — Crie as variáveis na Collection

1. Clique com o botão direito na Collection Toplojas e escolha Edit.

2. Abra a aba Variables e cadastre:

Variável	Valor inicial (Initial value)
token	o Token da sua loja
loja	o Identificador da sua loja

1. Salve.

Passo 2 — Configure os headers na Collection

1. Ainda na edição da Collection, abra a aba Authorization e escolha o tipo Bearer Token.

2. No campo Token, informe:

{{token}}

1. Abra a aba Headers e adicione o header da loja:

Key	Value
Loja	{{loja}}

1. Salve.

Como cada requisição herda a autenticação da Collection, todos os endpoints já ficam prontos para uso. Se preferir, você também pode informar o Authorization: Bearer {{token}} e o Loja: {{loja}} diretamente na aba Headers de cada requisição.

▶️ Testando

Abra qualquer requisição da Collection — por exemplo, Outros → /status/ — e clique em Send. Se a autenticação estiver correta, você receberá uma resposta de sucesso da API.

Pronto! A partir daqui você pode explorar e testar todos os métodos da API pelo Postman.

Prefere testar sem instalar nada? Use o nosso simulador online: