Pular para o conteúdo principal

Gerar chave de API

A chave de API é a credencial que autoriza um sistema externo a acessar a sua conta Juridiq. Cada chave é exclusiva do seu escritório e recebe um nome que identifica onde ela será utilizada.

Como acessar?​

Acesse a aba Chaves de API dentro da área de API (veja como chegar em Gerenciamento da API).

Como gerar uma chave​

  1. Na aba Chaves de API, clique em "Gerar Chave de API".
  2. No campo Nome da chave, informe um nome que identifique onde a chave será usada (por exemplo, o nome da integração ou do sistema que vai se conectar).

Janela para gerar uma nova chave de API

  1. Clique em "Gerar chave" para concluir.

A nova chave passa a aparecer na lista, com o nome informado, o valor mascarado (juridiq_••••••••) e a data de criação. Guarde a chave em local seguro assim que ela for gerada, pois na lista o valor é sempre exibido de forma oculta.

Como usar a chave​

Na coluna Chave (Oculta), o valor é sempre exibido de forma mascarada (juridiq_••••••••). Trate a chave como uma senha: ela concede acesso aos dados do escritório e não deve ser compartilhada.

Para se conectar ao Juridiq, o sistema externo deve enviar a chave em todas as requisições, no cabeçalho x-juridiq-api-key. Entenda melhor em Rotas e recursos da API.

Excluir uma chave​

Para revogar o acesso de um sistema, localize a chave na lista e clique no ícone de exclusão, na coluna Ações. Após a exclusão, qualquer sistema que utilizava aquela chave deixa de ter acesso à sua conta.

Observações​

  • Crie uma chave para cada sistema ou integração. Assim, você identifica o uso de cada uma e pode revogar apenas a que precisar, sem afetar as demais.
  • Se uma chave for exposta indevidamente, exclua-a e gere uma nova.