Pular para o conteúdo principal

Encontrar rotas e recursos disponíveis

Cada rota é uma operação que um sistema externo pode executar, como listar registros ou criar um evento. Consulte a referência oficial ou o esquema OpenAPI para obter a lista atual. O índice publicado da API inclui, entre outros, grupos de ação, comentários de tarefas, eventos, arquivos, processos e campos personalizados. Abra o grupo correspondente para ver as operações disponíveis; a existência de um recurso no JuridIQ não garante que todas as ações da interface tenham uma rota pública.

Como encontrar a operação certa​

  1. No JuridIQ, abra Configurações → Integrações & API → API e clique em Ver documentação. Também é possível abrir a referência pelo link acima.
  2. Na API Reference, escolha o grupo do recurso. Por exemplo, para anexar um arquivo a um processo, procure as operações do grupo Files; para consultar um processo, procure Law Suits.
  3. Dentro do grupo, escolha a ação: listar, buscar, criar, atualizar ou excluir, conforme o trabalho que precisa executar. Uma rota de listagem não tem o mesmo efeito de uma rota de criação ou exclusão.
  4. Abra a operação e leia o método, o caminho, a autenticação, os parâmetros, o corpo da requisição, os exemplos de resposta e os possíveis códigos de erro antes de testá-la.

Ler uma rota antes de usá-la​

Para cada operação, confira na referência:

  1. o método e o caminho, incluindo identificadores exigidos na URL;
  2. se exige autenticação e o cabeçalho da chave;
  3. os parâmetros obrigatórios e opcionais;
  4. o formato do corpo de uma operação de criação ou atualização;
  5. o formato da resposta e os erros possíveis;
  6. a paginação, quando a rota for de listagem;
  7. os limites e condições descritos para o endpoint.

Não presuma que todos os recursos exibidos na interface têm uma rota de API. Use somente operações listadas na referência oficial.

Autenticação e testes​

Gere uma credencial em Configurações da API. Envie-a no cabeçalho x-juridiq-api-key, conforme o exemplo da rota escolhida.

Para fazer um primeiro teste, escolha uma operação de leitura, siga o exemplo de requisição da própria rota e insira a chave somente no local seguro indicado pela referência. Se a página oferecer um controle de teste interativo, preencha os parâmetros exigidos e revise a requisição antes de enviá-la. Confira o código de resposta e se os dados retornados pertencem ao escritório esperado. Em rotas de listagem, observe os parâmetros de página e quantidade por página indicados para aquela operação; não assuma que todos usam os mesmos nomes.

Para criar, atualizar ou excluir, confirme o identificador do registro, os campos obrigatórios e o efeito da operação antes do envio. Um teste de escrita pode alterar os dados reais do escritório. Caso haja erro, compare o código e a mensagem retornados com a seção de respostas da rota. Uma chave ausente, incorreta ou revogada deve ser verificada na área de chaves; problemas de parâmetro devem ser conferidos na operação específica.

Para uso por assistentes, o servidor MCP exige habilitação própria e segue tutoriais separados: Conectar o Claude e Conectar o ChatGPT. O campo Authorization: Bearer ... do fluxo MCP com ChatGPT não substitui o cabeçalho x-juridiq-api-key da API REST.