Visão geral da API Consultiva
O que é a API Consultiva do ssOtica, para que serve e como ela está organizada.
A API Consultiva (v1) é a API de consulta (leitura) do ssOtica — usa apenas o método
GET e não altera nenhum dado. Permite que sistemas externos leiam dados das lojas, sempre
dentro da rede do usuário autenticado.
Para que serve
Casos de uso comuns:
- Business Intelligence (BI): integrar com Power BI, Google Data Studio e similares, com relatórios sempre atualizados.
- Relatórios personalizados e painéis gerenciais.
- Sistemas de bonificação e cobrança.
Por ser somente leitura, a API não insere, edita nem exclui informações — o que garante segurança e estabilidade dos dados.
Escopo
Listagens
Clientes, funcionários e formas de pagamento.
Vendas
Vendas detalhadas, resumos por vendedor e por produto.
Produtos
Produtos, estoque, reservas em O.S., preço, grupo, grife e fornecedores.
Financeiro
Saldos, extrato, lançamentos de caixa, contas a receber e a pagar.
Ordens de Serviço
Ordens de serviço por período.
Autenticação em resumo
Todas as chamadas usam um token de acesso (Bearer) obtido no sistema ssOtica
(Cadastro › Usuários, perfil de administrador), e identificam a empresa por empresa
(Código da Licença) ou cnpj:
Authorization: Bearer {seu_token}Veja Autenticação para os detalhes.
Ambientes
| Ambiente | Base URL |
|---|---|
| Desenvolvimento / staging | https://ssotica-dev.ipe.digital/api/v1 |
| Produção | https://app.ssotica.com.br/api/v1 |
Próximos passos
Primeiros passos
Faça sua primeira consulta.
Paginação e limites
Paginação, janela de período e limites de uso.
Novidades
Recursos recém-disponibilizados.
Central de Ajuda
Esta documentação técnica complementa o material da Central de Ajuda do ssOtica ("Entendendo a API Consultiva" e o "Manual Técnico"). A contratação da API é feita pelo chat de atendimento do sistema.