Olá, Cliente!

 

Se você utiliza a API Consultiva do ssOtica para integrar seus sistemas, temos uma grande novidade! 🚀

 

A partir de amanhã (01/07), disponibilizaremos a API Consultiva v2, uma evolução da API atual, trazendo novos endpoints, consultas mais completas e melhorias que oferecem muito mais autonomia para integrações e extração de informações estratégicas do sistema.

 

A nova versão foi desenvolvida para ampliar o acesso a informações cadastrais e financeiras, além de tornar as integrações mais robustas, com documentação aprimorada e novos recursos para facilitar o desenvolvimento.

 

Mais afinal, o que é API? 

 

Para entender melhor acesse o material: Entendendo a API Consultiva

 

O que muda na API Consultiva v2?

 

Além de alguns endpoints já existentes, a versão 2 passa a disponibilizar novos recursos e diversas melhorias.

 

💰 Novo endpoint para consultas de Saldos das Contas Financeiras

 

Agora é possível consultar o saldo consolidado das contas financeiras, considerando o período informado na requisição.

 

Diferente da versão anterior, que retornava apenas as movimentações financeiras, o novo endpoint apresenta o saldo calculado conforme as regras utilizadas no Financeiro do ssOtica.

 

 

📝 Novos atributos de consulta no endpoint de Contas a Pagar

 

O campo de ocorrências foi ampliado e agora retorna um histórico muito mais completo das alterações realizadas nos títulos.

 

Agora são registradas informações como:

 

✅ Inclusões

✅ Alterações

✅ Exclusões

✅ Usuário responsável pela ação

✅ Data da ocorrência

✅ Hora da ocorrência

 

📝 Novos atributos no endpoint de Ordem de Serviço

 

  • Valor a Receber;
  • Valor referente trocas (Utilizado e valor pago a mais)
  • Status da OS – anteriormente, a API retornava apenas Ordens de Serviço ativas. Agora, também são disponibilizados os status de Perdida e Cancelada.

 

💳 Novo endpoint de Formas de Pagamento

 

A API agora permite consultar todas as formas de pagamento cadastradas no sistema.

Além das informações básicas, também são disponibilizadas informações relacionadas às configurações e taxas cadastradas para cada forma de pagamento.

O endpoint possui suporte à paginação.

 

 

👥 Novo endpoint de Clientes

 

Agora também é possível consultar diretamente os clientes cadastrados no sistema.

Entre os recursos disponíveis estão:

✅ Consulta paginada

✅ Busca por CPF ou CNPJ

 

👤 Novo endpoint de Funcionários

 

Foi disponibilizado um novo endpoint para consulta dos funcionários cadastrados no sistema.

O recurso também conta com paginação para otimizar consultas com grandes volumes de registros.

 

📅 Consultas com período ampliado

 

A API passa a permitir consultas com períodos muito maiores.

Agora é possível realizar consultas de até 6 meses, reduzindo a necessidade de múltiplas requisições para obtenção de informações históricas.

 

Além disso, todos os endpoints com grande volume de dados passam a utilizar paginação, garantindo melhor desempenho durante as consultas.

 

⚠️ Mensagens de erro mais claras

 

Os retornos da API foram revisados para facilitar a identificação de problemas durante as integrações.

Agora as mensagens seguem um padrão único e apresentam informações mais descritivas, facilitando o desenvolvimento e a manutenção das integrações.

 

📚 Documentação totalmente revisada

 

A documentação da API também foi atualizada.

Agora ela conta com:

 

✅ Exemplos de requisição

✅ Exemplos de respostas de sucesso

✅ Exemplos de mensagens de erro

✅ Documentação de autenticação

✅ Documentação da paginação

✅ Informações sobre limites de utilização (Rate Limiting)

✅ Descrição completa dos novos endpoints

 

Para mais informações técnicas: Acesse aqui! 

 

Regras importantes


Para garantir segurança e desempenho das integrações, algumas regras permanecem válidas na API Consultiva v2:

 

✅ A autenticação continua sendo realizada através de Bearer Token.

✅ Os novos endpoints respeitam as mesmas permissões de acesso já existentes na API Consultiva.

✅ Endpoints que retornam grandes volumes de dados utilizam paginação obrigatória.

✅ O cálculo dos saldos financeiros segue exatamente as mesmas regras utilizadas pelo Financeiro do ssOtica.

 

⚠️ Atenção

 

As integrações que já utilizam a API Consultiva atual (Versão 1) continuarão funcionando normalmente.

 

Para evitar impactos nas integrações existentes, os novos recursos disponibilizados na API Consultiva v2 não serão aplicados automaticamente às integrações já existentes.

 

Caso sua empresa deseje utilizar os novos endpoints, consultas e atributos disponíveis na versão 2, será necessário que a equipe responsável pela integração realize os ajustes necessários para consumir a nova API.

 

Recomendamos compartilhar esta documentação com o responsável técnico pela integração para que a migração seja realizada quando houver interesse em utilizar os novos recursos.

 

👉 E, para contratar, acesse agora mesmo o chat no canto esquerdo do seu sistema e fale com um de nossos consultores.

 

Comentar importante com preenchimento sólidoLembramos também, que todas as melhorias realizadas no sistema, gradativamente também vão sendo atualizadas para a versão mobile.

 

Gostou das novidades?
 
 Então fica de olho aqui na Central de Ajuda, que em breve tem muito mais!!!

 

E se ficou com alguma dúvida? Não se preocupe!

 

É só entrar em contato com nosso suporte através do chat do sistema!

 

Até logo! 😊