Integração por API - Perguntas e respostas

O que é uma API?

É a forma com que um sistema expõe seus dados e funcionalidades para outras aplicações. Através de uma interface protegida por senha, quem tiver acesso a API poderá inserir dados no sistema, ler os dados, iniciar algum job, etc. Para informações mais detalhadas: https://canaltech.com.br/software/o-que-e-api/.

O que a API do ADV proporciona?

A API do sistema possibilita que o cliente, através de um usuário e senha, tenha acesso aos dados de seu arrendatário, bem como consiga manusear esses dados (inserir, editar e excluir). Com esse acesso o cliente pode então contratar um terceiro que irá realizar as integrações necessárias a sua necessidade, por exemplo: Buscar informações de outras sistemas e inserir automaticamente no ADV.

Comerciais

A API está acessível para todos os planos do ADV?

O acesso a API é fornecido apenas para clientes que contratam este serviço adicional. No processo de ativação o escritório receberá uma chave de acesso para utilizar a API do ADV. Recomendamos a contratação de 6 horas de consultoria para a integração, caso necessite de qualquer suporte ou esclarecimento sobre a API. O Suporte técnico do ADV não cobre assuntos relacionados a integração. 

Ao contratar a consultoria par a integração via API o escritório deve possuir um desenvolvedor ou empresa com capacidade técnica para realizar integração entre sistemas. Caso não possua este profissional ou empresa, recomendamos utilizar uma das soluções que já estão integradas ao sistema de forma nativa.

Posso utilizar a API de captura apenas para capturar intimações?

Sim, é possível utilizar a nossa API apenas para capturar intimações ou qualquer entidade do sistema. Entretanto, nestes casos, pode ser melhor utilizar um fornecedor exclusivo de intimações como AASP, pois você vai estar pagando por todo o sistema para utilizar apenas uma parte dos benefícios.

O que preciso para acessar a API do ADV?

Inicialmente você precisa estar em um plano que tenha a API inclusa ou contratar o serviço adicional de API. Também é necessário ter um profissional de TI ou empresa que tenha conhecimento e experiência na integração com sistemas. Possuímos uma documentação técnica que pode ser utilizada por estes empresas com exemplos de conexão. É extremamente recomendável que a documentação técnica seja lida antes de iniciar um projeto de integração.

Técnicas

Existe uma documentação das integrações disponíveis?

Sim, existe uma documentação que é gerada automaticamente pelo sistema que pode ser acessada no link abaixo:

https://docs.sajadv.com.br/

Também possuímos documentação de alguns módulos com exemplos práticos neste link:

Integrações ADV

Posso criar novos aplicativos através da API?

Sim, é possível criar aplicativos personalizados para o escritório a partir da API como um aplicativo Mobile para clientes do escritório, Plugins para Outlook, etc.

Posso integrar o sistema com uma aplicação para produção de documentos e obter as informações dos processos?

Sim, através da nossa API é possível obter os dados do processo, como número, órgão julgador, partes, pedidos, entre outras. Você pode utilizar ferramentas de terceiros integradas ao ADV.

Quais serviços estão disponíveis para a integração através da API?

Através da API do ADV é possível realizar ações de cadastrar, excluir e consultar das entidades de pessoas, atendimentos, processos, tarefas, andamentos, apontamento de horas e arquivos.

Os campos personalizados são acessíveis pela API?

Sim, os campos personalizados são acessíveis pela API. Documentação: https://docs.sajadv.com.br/resource_Campo_Dinâmico.html

Posso realizar a migração de dados através da API?

Sim, é possível realizar a migração de dados pela API, por essa interface de conexão é possível inserir, alterar ou excluir dados das diversas entidades do sistema, além de enviar documentos.

A API de integração possuí webhooks?

Não, no momento nossa API não oferece Webhooks.

Posso alterar a interface do sistema através da API?

A API serve para consultar, inserir ou excluir dados no sistema. Não é possível alterar a interface.

Existe limite de requisições na API?

Sim, existe um limite de 480 requisições por minuto. 

Existe alguma forma de acessar o banco de dados do sistema?

Não é possível acessar o banco de dados, toda a consulta ou extração de dados é feita pela API. Não é possível acessar diretamente o banco de dados ou Views do Banco de dados.

Em quantas horas o token de acesso expira?

O token de acesso expira após 12 horas. Basta então realizar nova requisição conforme nossa documentação para obter um novo.