Pular para o conteúdo principal

Consultar a documentação da API

Use a referência oficial para confirmar os endpoints, parâmetros, esquemas de dados e respostas disponíveis.

Abrir a referência​

  1. No JuridIQ, abra o menu do usuário e entre em Configurações.
  2. Em Integrações & API, selecione API.
  3. Na aba Chaves de API, clique em Ver documentação. O botão Documentação da API no alto da área também abre a referência.
  4. Na referência, comece pelas orientações de autenticação. Depois abra o recurso e a operação que pretende utilizar.

Área atual de chaves de API e botão Ver documentação

Preparar uma integração​

  1. Leia a seção de autenticação da documentação oficial e identifique os requisitos da operação desejada.
  2. Confirme o endpoint, método, parâmetros e estrutura de resposta na referência atual. Evite copiar exemplos de documentação antiga se divergirem da referência publicada.
  3. Gere uma chave de API pela página de configurações. Veja Gerar uma chave de API.
  4. Envie a chave no cabeçalho x-juridiq-api-key, conforme documentado pela plataforma.
  5. Teste primeiro uma operação de leitura e valide o retorno. Antes de executar qualquer gravação, confirme o escritório, o registro e o efeito esperado.

Na referência, confira os grupos de recursos, o método HTTP, a URL da operação, os parâmetros, os exemplos de resposta e os códigos de erro. Use Rotas e recursos para interpretar essa estrutura. As rotas e os campos podem evoluir: a documentação oficial e o esquema OpenAPI são a fonte para saber quais operações estão disponíveis no momento.

O MCP usa um fluxo de conexão diferente da API REST. Veja os tutoriais específicos para Claude e ChatGPT.