Guias

Primeiros passos

Como realizar a primeira consulta à API Consultiva em três etapas.

1. Obtenha a chave de acesso

A chave de acesso fica disponível no cadastro do usuário, no ssOtica, e é exibida ao abrir o usuário para edição. A loja precisa ter a API contratada. Mais detalhes em Autenticação.

2. Monte a requisição

  • Endereço base (produção): https://app.ssotica.com.br/api/v1
  • Cabeçalhos HTTP: Authorization: Bearer {sua_chave} e Accept: application/json
  • Identificação da loja: empresa (Código da Licença) ou cnpj

3. Realize a consulta

Exemplo de consulta às vendas de junho de 2026:

curl -G https://app.ssotica.com.br/api/v1/integracoes/vendas/periodo \
  -H "Authorization: Bearer {sua_chave}" \
  -H "Accept: application/json" \
  --data-urlencode "cnpj=12345678000199" \
  --data-urlencode "inicio_periodo=2026-06-01" \
  --data-urlencode "fim_periodo=2026-06-30" \
  --data-urlencode "page=1" \
  --data-urlencode "perPage=100"

Para obter todos os registros, repita a requisição com page=2, page=3 e assim por diante, até o valor de totalPages informado na resposta. Consulte Paginação e limites.

Próximos passos

A página de cada endpoint, na Referência, apresenta os parâmetros aceitos, um exemplo de resposta e um ambiente de testes que pode ser utilizado diretamente no navegador, informando a chave no campo Authorization.

On this page