Nova requisição
Utilizado para realizar novas consultas aos tribunais. As consultas mais utilizadas são por: CNJ, documento da parte (CPF/CNPJ) ou nome da parte.
Ao realizar a consulta, um ID é gerado para a consulta e um status inicial. É possível obter as informações finais de duas formas: callback ou consulta via /request/{requestId}
.
Atenção!
Para usar essa rota deve consultar nossa abrangência em /available
Informações
CNJ (Conselho Nacional de Justiça)
Formato: NNNNNNN-DD.AAAA.J.TR.OOOO
Parte | Descrição |
---|---|
NNNNNNN | Número sequencial de cada tribunal - reiniciado todo ano |
DD | Dígito verificador do número sequencial |
AAAA | Ano do processo |
J | Número da justiça correspondente * |
TR | Número correspondente ao poder judiciário que atua na região |
OOOO | Origem - órgão/comarca que vai julgar |
Processos em Segredo de Justiça
Para capturar Processos em Segredo de Justiça é necessário passar a credencial de acordo com os parâmetros informados abaixo.
É necessário que a credencial seja válida no sistema especificado.
Estrutura do objeto Credentials.
Requisição
POST https://api.capturaweb.com.br/v1/request
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
source | string | true | Example: courts |
platform | string | true | Example: esaj |
search | string | true | Example: tjba |
query | string | true | Example: principal |
makeDownload | boolean | false | Retorna link de arquivos anexados. Example: true |
param | object | true | Params |
callbacks | array | true | Callbacks |
credentials | object | false | Autenticação para Segredo de Justiça. Credentials |
Exemplos
- cURL
- Python
- PHP
- NodeJs
curl --request POST \
--url https://api.capturaweb.com.br/v1/request \
--header 'Authorization: Bearer eyJh…..bkA' \
--header 'Content-Type: application/json' \
--data '{
"source": "courts",
"platform": "esaj",
"search": "tjsp",
"query": "principal",
"param": {
"key": "cnj",
"value": "0002796-14.2013.8.26.0323"
},
"callbacks": [],
"credentials": {
"login": "123456",
"platform": "esaj",
"type": "codilo"
}
}'
import requests
headers = {
'Authorization': 'Bearer eyJh…..bkA',
'Content-Type': 'application/json',
}
json_data = {
'source': 'courts',
'platform': 'esaj',
'search': 'tjsp',
'query': 'principal',
'param': {
'key': 'cnj',
'value': '0002796-14.2013.8.26.0323',
},
'callbacks': [],
'credentials': {
'login': '123456',
'platform': 'esaj',
'type': 'codilo',
},
}
response = requests.post('https://api.capturaweb.com.br/v1/request', headers=headers, json=json_data)
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/request');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer eyJh…..bkA",
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n \"source\": \"courts\",\n \"platform\": \"esaj\",\n \"search\": \"tjsp\",\n \"query\": \"principal\",\n \"param\": {\n \"key\": \"cnj\",\n \"value\": \"0002796-14.2013.8.26.0323\"\n },\n \"callbacks\": [],\n \"credentials\": {\n \"login\": \"123456\",\n \"platform\": \"esaj\",\n \"type\": \"codilo\"\n }\n}");
$response = curl_exec($ch);
curl_close($ch);
fetch('https://api.capturaweb.com.br/v1/request', {
method: 'POST',
headers: {
Authorization: 'Bearer eyJh…..bkA',
'Content-Type': 'application/json',
},
body: JSON.stringify({
source: 'courts',
platform: 'esaj',
search: 'tjsp',
query: 'principal',
param: {
key: 'cnj',
value: '0002796-14.2013.8.26.0323',
},
callbacks: [],
credentials: {
login: '123456',
platform: 'esaj',
type: 'codilo',
},
}),
});
Respostas
- Sucesso
{
"success": true,
"data": {
"id": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
"status": "pending",
"source": "courts",
"platform": "esaj",
"query": "principal",
"court": "tjsp",
"search": "tjsp",
"credentials": false,
"param": {
"key": "cnj",
"value": "0002796-14.2013.8.26.0323"
},
"respondedAt": null,
"createdAt": "2022-03-08T00:26:26.088Z"
}
}
Status | Significado | Descrição | Schema |
---|---|---|---|
200 | OK | Sucesso | None |
401 | Undocumented | "key" must be one of [cnj, number, cartaprecatoria, doc, documentodelegacia, legado, nome, nomeadvogado, oab, numerocda, nomeadv, nomeparte, numorigem, numregistro, numstj] | None |
401 | Unauthorized | Access denied | None |
429 | Too Many Requests | Waiting for request data | None |
Objetos
Params
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
param | key string | true | Example: cnj |
value | string | true | Example: 0500275-63.2017.8.05.0103 |
Callbacks
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
method | string | true | Example: POST |
url | string | true | Example: http://callback.seudominio.com.br |
Credentials
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
type | string | true | Aceita o formato codilo |
login | string | true | Login que será enviado para o autenticador |
platform | string | true | Plataforma que será usada a credencial |