Ligar outro sistema ao JurisOS (API)
Em uma fraseA API deixa outro sistema ler e gravar dados no JurisOS. Em Integrações > API, você cria uma chave para cada sistema e escolhe se ela só consulta ou também cria e edita. O Manual da API mostra como usar.
Para que serve
A API é a porta para outro sistema conversar com o JurisOS. Por ela, o site do escritório, uma planilha ou uma automação lê e grava dados no JurisOS sem ninguém digitar.
Cada sistema entra com uma chave própria: um código secreto, como uma senha. Assim você corta o acesso de um sistema sem parar os outros.
Criar uma chave
- Em Integrações, no cartão API, clique em Ver chaves.
- Em Chaves de API, clique em Nova chave.
- Em Nome da chave, escreva o sistema que vai usá-la, por exemplo "Site do escritório".
- Em Permissão, escolha Consultar (só ler) ou Criar e editar (ler e também gravar).
- Se escolheu Criar e editar, ligue Cobranças ou Contato com clientes só se o sistema precisar.
- Em Expiração, escolha por quanto tempo a chave vale: Sem (não vence), 30 dias, 90 dias ou 1 ano.
- Clique em Gerar chave.
- Copie a chave e clique em Concluir.
Atenção: a chave aparece uma vez só. Depois, a tela mostra apenas o começo dela. Se perder, crie outra.
Entregar ao programador
Passe ao programador a chave e o endereço que aparece no topo da página. A chave vai no cabeçalho Authorization: Bearer SUA_CHAVE. O botão Manual da API abre as instruções técnicas: o que dá para consultar, as operações disponíveis e um exemplo pronto para colar.
Dica: uma chave com Cobranças emite PIX e boleto de verdade e só funciona com os pagamentos conectados. Ela segue a régua do escritório (limites como o valor máximo por cobrança e por dia), que fica nesta mesma página.
Cortar uma chave
Na lista de chaves, clique em Revogar e confirme. O sistema que usava essa chave para de funcionar na hora. Não dá para desfazer.
Dúvidas comuns
Posso mudar o nome ou a permissão de uma chave?
Não. Revogue a chave e crie outra com o que precisa.
Por que não consigo criar uma chave?
Porque é preciso ser Administrador ou ter a aba Integrações liberada em Equipe.
Quantas chamadas a API aceita?
No padrão, até 120 por minuto para cada chave (chamada é cada pedido do outro sistema). Passando disso, é só aguardar alguns segundos.