Pular para o conteúdo principal

Documentação da API

A documentação da API reúne todas as informações técnicas necessárias para integrar sistemas ao Juridiq: como autenticar as requisições, quais rotas existem e o formato das respostas.

Como acessar?​

A partir da área de API (veja como chegar em Gerenciamento da API), você pode abrir a documentação de duas formas:

  • Pela aba Documentação da API; ou
  • Pelo botão "Ver documentação", disponível na aba Chaves de API.

Documentação da API do Juridiq

O que você encontra na documentação​

A documentação é organizada em duas partes:

Primeiros Passos — a base para começar a integrar:

  • Introdução: visão geral da API e do que é possível fazer com ela.
  • Autenticação: como identificar o seu escritório nas requisições.
  • Status Codes: os códigos de resposta HTTP retornados pela API.

API Reference — a lista completa de rotas (endpoints), organizada por recurso. Veja quais recursos estão disponíveis em Rotas e recursos da API.

Informações técnicas​

  • URL base: https://api.juridiq.com.br
  • Formato: todas as requisições e respostas utilizam JSON e seguem os padrões HTTP convencionais.
  • Autenticação: cada requisição deve enviar a chave de API do escritório no cabeçalho x-juridiq-api-key. Gere a sua em Gerar chave de API.