Primeiros passos

Este guia mostra o caminho mais curto até uma consulta autenticada bem-sucedida.

1. Obtenha seu token

A API Consultiva é autenticada por um token de acesso (chave da API) gerado no próprio sistema ssOtica: o administrador acessa Cadastro › Usuários e copia o código de acesso exibido no perfil. Não há endpoint de login nesta API.

Envie o token em todas as chamadas no header:

Authorization: Bearer {seu_token}

Detalhes (requisitos do perfil, onde fica o Código da Licença) em Autenticação.

Acesso via API

O usuário/empresa precisa ter o acesso via API contratado. Caso contrário, as consultas retornam erro (ERRO_INTERNO — "Acesso via API não contratado...").

2. Escolha o ambiente

Ambiente	Base URL
Desenvolvimento / staging	`https://ssotica-dev.ipe.digital/api/v1`
Produção	`https://app.ssotica.com.br/api/v1`

Comece sempre por desenvolvimento e só vá para produção após validar a integração.

3. Faça sua primeira consulta

Informe o CNPJ da loja (ou a chave de contrato em empresa) e o período:

curl -G https://ssotica-dev.ipe.digital/api/v1/integracoes/vendas/periodo \
  -H "Authorization: Bearer {seu_token}" \
  --data-urlencode "cnpj=12345678000199" \
  --data-urlencode "inicio_periodo=2026-06-01" \
  --data-urlencode "fim_periodo=2026-06-30"

Listagens auxiliares (clientes, funcionários, formas de pagamento) ajudam a montar filtros:

curl -G https://ssotica-dev.ipe.digital/api/v1/integracoes/clientes \
  -H "Authorization: Bearer {seu_token}" \
  --data-urlencode "cnpj=12345678000199"

4. Explore a referência

Cada endpoint na Referência traz parâmetros, exemplos de resposta e um playground "Try it" para testar direto do navegador (basta colar o token no campo Authorization).

Conceitos

Envelope de resposta, erros, datas, paginação e multi-tenancy.

Referência

Todos os endpoints da API Consultiva.