API Consultiva ssOtica

👉 Documentação oficial da API Consultiva

A documentação oficial reúne todos os detalhes técnicos da API: endereços, parâmetros, exemplos de resposta e um ambiente para testes.

Sua integração utiliza a versão anterior da API?

As integrações desenvolvidas com a versão anterior permanecem em funcionamento, pois os endereços de consulta não foram alterados. Ainda assim, recomendamos adotar a documentação oficial: além de todos os recursos já disponíveis, ela oferece funcionalidades adicionais, como a paginação de resultados e a busca avançada de produtos.

Para esclarecer dúvidas sobre a versão anterior, consulte o Manual Técnico da API Consultiva (versão anterior)

 

Primeira vez com a API? Conheça a solução

➡️ O que é uma API?

API é a sigla para Application Programming Interface, em português Interface de Programação de Aplicações. Trata-se de um canal de comunicação entre sistemas, que permite a troca de informações de forma automatizada e segura, sem necessidade de intervenção manual.

➡️ A API Consultiva do ssOtica

O ssOtica disponibiliza uma API do tipo consultiva, baseada no método GET. Ela é destinada exclusivamente à leitura de dados: não permite incluir, alterar ou excluir informações do sistema.

Com ela, é possível integrar os dados do ssOtica a outras soluções, como:

  • ferramentas de Business Intelligence (BI), como Power BI e Looker Studio (antigo Google Data Studio);

  • relatórios gerenciais personalizados;

  • sistemas de bonificação e de cobrança.

Entre as informações disponíveis para consulta estão:

  • vendas;

  • produtos e estoque;

  • ordens de serviço;

  • informações financeiras: extrato, lançamentos de caixa, contas a receber e contas a pagar;

  • cadastros de clientes, funcionários e formas de pagamento.

➡️ Principais vantagens

✅ Automação de relatórios: os dados do ssOtica alimentam diretamente ferramentas como o Power BI, com relatórios sempre atualizados.

✅ Eliminação de processos manuais: as informações são obtidas diretamente do sistema, sem necessidade de exportar planilhas.

✅ Visão gerencial integrada: vendas, estoque e financeiro reunidos oferecem ao gestor uma visão estratégica do negócio.

✅ Segurança dos dados: por ser exclusivamente de consulta, a API não realiza nenhuma alteração no sistema.

⚠️ Antes de contratar

  • Verifique com o sistema parceiro (aquele que receberá os dados) se as informações disponibilizadas pela API atendem à integração pretendida. A documentação oficial, indicada no início deste artigo, apoia essa avaliação.

  • Confirmada a viabilidade, entre em contato com a nossa equipe de Atendimento pelo chat, no canto inferior esquerdo do sistema, e solicite a contratação da API.

➡️ Liberação do acesso ao parceiro

Após a contratação, o administrador do sistema deve encaminhar a chave de acesso à empresa parceira:

  1. No ssOtica, abra o cadastro do usuário para edição. A chave de acesso é exibida nessa tela.

  2. Encaminhe a chave à empresa parceira, junto com o link da documentação oficial.

⚠️ A chave de acesso é exibida somente para usuários administradores com acesso à empresa contratante da API.

Em caso de dúvidas, nossa equipe de suporte está à disposição pelo chat do sistema.