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
- No JuridIQ, abra o menu do usuário e entre em Configurações.
- Em Integrações & API, selecione API.
- 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.
- Na referência, comece pelas orientações de autenticação. Depois abra o recurso e a operação que pretende utilizar.

Preparar uma integração
- Leia a seção de autenticação da documentação oficial e identifique os requisitos da operação desejada.
- 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.
- Gere uma chave de API pela página de configurações. Veja Gerar uma chave de API.
- Envie a chave no cabeçalho
x-juridiq-api-key, conforme documentado pela plataforma. - 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.