Rotas e recursos da API

As rotas (endpoints) são os endereços que o sistema externo utiliza para ler e registrar informações no Juridiq. Cada recurso do escritório tem o seu próprio conjunto de rotas.

---

Como acessar?

Abra a Documentação da API e acesse a seção API Reference (veja como chegar em Documentação da API). As rotas ficam agrupadas por recurso, dentro de Endpoint.

Recursos disponíveis

A API disponibiliza rotas para os seguintes recursos:

• Action Groups — grupos de ação.
• Events — eventos.
• Law Suits — processos.
• Persons — pessoas (clientes e partes).
• Tasks — tarefas.
• Type Actions — tipos de ação.
• Users — usuários.
• Tags — etiquetas.
• Publications — publicações.
• Degree of Risk — grau de risco.
• Audiences — audiências.
• TimeSheets — registros de horas.

Testar uma rota

A documentação permite testar cada rota diretamente pelo navegador, sem precisar de nenhum programa adicional:

1. Abra a rota desejada (por exemplo, GET /actionGroup/).
2. Informe a sua chave de API no campo de autorização x-juridiq-api-key.
3. Preencha os parâmetros disponíveis, quando houver. As rotas de listagem costumam aceitar page (página, começa em 1) e limit (quantidade de itens por página).
4. Clique em "Try it" para enviar a requisição e ver a resposta.

Autenticação

Toda requisição precisa incluir a chave de API do escritório no cabeçalho x-juridiq-api-key. Sem uma chave válida, a requisição é recusada. Veja como gerar a sua em Gerar chave de API.

Exemplo de requisição com cURL:

curl --request GET \
  --url https://api.juridiq.com.br/actionGroup/ \
  --header 'x-juridiq-api-key: <sua-chave>'

Formato das respostas

As respostas são retornadas em JSON. Nas rotas de listagem, os registros vêm no campo data, acompanhados do total de resultados e do total de páginas:

{
  "data": [
    {
      "id": "...",
      "name": "...",
      "officeId": "...",
      "updatedAt": "...",
      "createdAt": "..."
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Observações

• Cada rota indica os códigos de resposta possíveis (por exemplo, 200 para sucesso e 400 para erro na requisição).
• Os campos retornados variam conforme o recurso consultado.