Nova Consulta Automática
Este endpoint realiza consultas automáticas em toda a abrangência disponível com base no número do processo (CNJ) informado.
A partir do CNJ, a ferramenta identifica automaticamente:
- A justiça correspondente
- O tribunal vinculado
- As plataformas disponíveis
- As instâncias aplicáveis (1º grau, 2º grau e tribunais superiores)
Com base nessa identificação, são criadas múltiplas requisições internas — uma para cada combinação de plataforma e instância encontrada.
Requisição
POST https://api.consulta.codilo.com.br/v1/autorequest
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| key | string | true | Tipo da consulta. Valor suportado: cnj |
| value | string | true | Número do processo no formato CNJ (NNNNNNN-DD.AAAA.J.TR.OOOO) |
| makeDownload | boolean | false | Indica se devem ser retornados links para download de anexos. Padrão: false |
| callbacks | array | false | Lista de endpoints para recebimento automático das atualizações |
| format | string | false | Define o formato do callback.default: envia um callback para cada mudança de status.allRequests: envia um único callback consolidado com todas as requisições criadas |
Exemplos de Requisição
- cURL
- Python
- PHP
- Node.js
curl -X POST "https://api.consulta.codilo.com.br/v1/autorequest" \
-H "Authorization: Bearer SEU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"key": "cnj",
"value": "0804495-71.2018.8.10.0001",
"callbacks": [
{
"method": "POST",
"url": "https://callback.seudominio.com.br/"
}
]
}'
import requests
headers = {
"Authorization": "Bearer SEU_ACCESS_TOKEN",
"Content-Type": "application/json"
}
payload = {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001",
"callbacks": [
{
"method": "POST",
"url": "https://callback.seudominio.com.br/"
}
]
}
response = requests.post(
"https://api.consulta.codilo.com.br/v1/autorequest",
headers=headers,
json=payload
)
print(response.json())
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/autorequest');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer SEU_ACCESS_TOKEN",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"key" => "cnj",
"value" => "0804495-71.2018.8.10.0001",
"callbacks" => [
[
"method" => "POST",
"url" => "https://callback.seudominio.com.br/"
]
]
]));
$response = curl_exec($ch);
curl_close($ch);
echo $response;
fetch("https://api.consulta.codilo.com.br/v1/autorequest", {
method: "POST",
headers: {
Authorization: "Bearer SEU_ACCESS_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
key: "cnj",
value: "0804495-71.2018.8.10.0001",
callbacks: [
{
method: "POST",
url: "https://callback.seudominio.com.br/",
},
],
}),
})
.then(response => response.json())
.then(data => console.log(data));
Exemplo de Resposta (200 - OK)
- Sucesso
{
"success": true,
"data": {
"id": "c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9",
"key": "cnj",
"value": "0804495-71.2018.8.10.0001",
"requests": [
{
"id": "471fd997-fa85-479e-a3a8-97d8391537bf",
"status": "pending",
"source": "courts",
"platform": "jurisconsult",
"query": "principal",
"court": "tjma"
}
],
"createdAt": "2022-03-08T01:06:42.664Z"
}
}
O campo requests contém a lista de requisições individuais criadas automaticamente para cada plataforma e instância identificada.
Status Codes
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Consulta automática criada com sucesso |
| 401 | Unauthorized | Token inválido, expirado ou não informado |
| 429 | Too Many Requests | Limite de requisições excedido |
Callbacks
Caso configurado, a ferramenta enviará automaticamente atualizações de status para os endpoints informados.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| method | string | true | Método HTTP utilizado no callback (ex: POST) |
| url | string | true | URL que receberá as notificações da consulta |