For the complete documentation index, see llms.txt. This page is also available as Markdown.

Guia Rápido

Este guia leva você do zero à sua primeira chamada bem-sucedida à API, em poucos minutos.

1️⃣ Obtenha o Token e o Identificador da Loja

No painel da loja, acesse Sistema → Configurações Gerais → API de Acesso Externo → Atualizar Token e copie o Identificador e o Token.

O passo a passo completo, com telas, está em:

Geração de Token

2️⃣ Monte a primeira requisição

Toda requisição precisa de dois headers de autenticação:

Authorization: Bearer [Token]
Loja: [Identificador de Sua Loja]

Vamos testar o endpoint /status/, que serve justamente para verificar se a API está disponível e se sua autenticação está correta:

curl -X GET "https://api.toplojas.com.br/status/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

Substitua [Token] e [Identificador de Sua Loja] pelos valores obtidos no passo 1.

3️⃣ Interprete a resposta

Se tudo estiver correto, a API responde com o HTTP Code 204 (sucesso, sem conteúdo). Isso significa que sua loja está autenticada e pronta para usar a API.

Se receber um erro, consulte:

Solução de Problemas

✅ Próximos passos

Agora que sua autenticação funciona, explore os módulos:

  • 🛒 Pedidos — consultar e gerenciar pedidos

  • 📦 Produtos — cadastrar e gerenciar produtos e estoque

  • 🔔 Webhook — receber notificações automáticas de eventos

Prefere testar sem escrever código? Use o Simulador Online ou configure o Postman.

Lembre-se dos limites e padrões da API (limite de requisições, formato de datas e decimais) descritos em Considerações Gerais.

Last updated