API Codilo
Role para baixo para obter exemplos de código, solicitações e respostas de exemplo. Selecione uma linguagem de programação para exemplos de código nas guias acima ou no menu de navegação móvel.
A API Codilo é uma ferramenta desenvolvida com a finalidade de auxiliar na importação de informações processuais disponíveis para consultas públicas.
Atualmente nosso serviço realiza acesso as plataformas dos tribunais, com opções para obtenção de dados, como capa do processo, andamentos, anexos, dentre outras informações disponíveis em consulta pública.
Também, de desenvolvimento de robôs customizados, onde as fontes não constam em nossa abrangência e/ou lista de robôs disponíveis.
Em nosso sistema os dados são estruturados, sem a necessidade de intervenção humana. Desenvolvido através de um longo estudo de mercado para que pudéssemos atender as principais dores das empresas que desenvolvem software jurídico.
Autenticacao
Temos um microserviço centralizado para autenticação em todos nossos sistemas: Auth https://auth.codilo.com.br/.
Para a utilização de nossas APIs, usamos o padrão OAuth2.0 de client_credentials.
OAuth2
Utilizado para receber um token válido (expirável) que deve ser informado em todos os endpoints da API.
Exemplos
curl --request POST \
--url https://auth.codilo.com.br/oauth/token \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data id=KEY_USUARIO \
--data secret=SECRET_USUARIOimport requests
data = {
'grant_type': 'client_credentials',
'id': 'KEY_USUARIO',
'secret': 'SECRET_USUARIO',
}
response = requests.post('https://auth.codilo.com.br/oauth/token', data=data)var request = require('request');
var headers = {
'Content-Type': 'application/x-www-form-urlencoded'
};
var dataString = 'grant_type=client_credentials&id=KEY_USUARIO&secret=SECRET_USUARIO';
var options = {
url: 'https://auth.codilo.com.br/oauth/token',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://auth.codilo.com.br/oauth/token');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'grant_type=client_credentials&id=KEY_USUARIO&secret=SECRET_USUARIO');
$response = curl_exec($ch);
curl_close($ch);{
"token_type": "bearer",
"access_token": "eyJhb….87ofw",
"expires_in": 3600
}Tipos de permissão
| Scope | Scope Descrição | Descrição |
|---|---|---|
| cw-api:admin | scope admin | Acesso total |
| cw-api:w | scope write | Somente escrita |
| cw-api:r | scope read | Somente leitura |
Requisição (curl)
POST https://auth.codilo.com.br/oauth/token
{ “grant_type”: “client_credentials”, “id”: “key”, “secret”: “secret” }
Retorno (json)
| token_type | Tipo do token retornado |
| access_token | Token de acesso gerado |
| expires_in | Tempo de expiração do token |
Na resposta, virá a propriedade access_token. Este é um JWT válido do usuário logado que pode ser usado em qualquer requisição de nossas APIs. Deve ser enviado como header na propriedade Authorization:.
Assim que qualquer destas requisições retornar Access Denied (Status Code: 401), deve ser gerado um novo access_token para ser reutilizado nas próximas consultas até sua expiração.
| 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 |
Fluxo
Obter token
Para o token, nossa API segue o padrão OAuth2 de client credentials.
O access_token via API deve ser obtido com um POST em: https://auth.codilo.com.br/oauth/token.
Utilizar body:
| {“grant_type”: “client_credentials”, “id”: “key”, “secret”: “secret”} |
Informar token nas requisicoes
Assim que retornado, o access_token será passado no header nas requisições da API, na propriedade Authorization.
Exemplo:
| Headers: { “Authorization”: “Bearer access_token_retornado” } |
Token expirado
Quando o token expirar, nossa API retorna Access Denied, sendo necessário solicitar um novo access_token no endpoint /oauth/token.
Available
Retorna lista de plataformas disponíveis
Lista a abrangência da nossa API.
Permite identificar quais tribunais, plataformas, instâncias nossa API consegue obter dados públicos. Possibilita também identificar os parâmetros a serem informados para a correta consulta dos dados.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/available" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
response = requests.get('https://api.capturaweb.com.br/v1/available', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/available');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/available',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": [
{
"source": "courts",
"Descrição": "Consulta de Tribunais",
"platforms": [
{
"platform": "custom",
"Descrição": "Plataforma Personalizada",
"searches": [
{
"search": "jef-trf3",
"Descrição": "Juizado Especial Federal da 3ª Região",
"queries": [
{
"query": "unificada",
"Descrição": "Consulta de Processos Unificada",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
}
]
},
{
"search": "jfsp",
"Descrição": "Justiça Federal de São Paulo",
"queries": [
{
"query": "unificada",
"Descrição": "Consulta de Processos Unificada",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
}
]
},
{
"search": "prefeitura-sp",
"Descrição": "Prefeitura da Cidade de São Paulo",
"queries": [
{
"query": "unificada",
"Descrição": "Consulta de Processos Unificada",
"params": [
{
"label": "Número (Processo/Documento/Solicitação)",
"tag": "number",
"mask": null,
"Obrigatório": true,
"nested": []
}
]
}
]
},
{
"search": "tjmg",
"Descrição": "Tribunal de Justiça de Minas Gerais",
"queries": [
{
"query": "principal",
"Descrição": "Consulta de Processos de 1º Grau",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
},
{
"query": "recursal",
"Descrição": "Consulta de Processos de 2º Grau",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
}
]
},
{
"search": "trf1",
"Descrição": "Tribunal Regional Federal da 1ª Região",
"queries": [
{
"query": "principal",
"Descrição": "Consulta de Processos de 1º Grau",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
},
{
"query": "recursal",
"Descrição": "Consulta de Processos de 2º Grau",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
}
]
},
{
"search": "trt1",
"Descrição": "Tribunal Regional do Trabalho da 1ª Região",
"queries": [
{
"query": "unificada",
"Descrição": "Consulta de Processos de 1º e 2º Grau",
"params": [
{
"label": "Numeração Única",
"tag": "cnj",
"mask": "#######-##.####.#.##.####",
"Obrigatório": true,
"nested": []
}
]
}
]
}
]
}
]
}
]
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/available
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cnj | string | false | Filtro pelo número CNJ para plataformas disponíveis em nossa API: ex.: 0030779-57.2015.8.10.0001 |
Retorno (json)
| 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 |
Consulta
O jurídico brasileiro, é composto por várias esferas judiciais, sendo as principais: Trabalho, Estadual e Federal. Cada esfera judicial engloba uma ou mais unidade federativa (estado), e pode ter mais de um sistema judicial para a consulta de processos.
Por esse motivo, desenvolvemos nossa API de Consulta para o usuário ter autonomia de buscar em qualquer sistema judicial disponível em nossa lista de abrangência /available.
Realizar uma NOVA requisicao
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}.
Exemplos
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": []
}'
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': []
}
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}");
$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': []
})
});{
"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"
}
}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 |
| * | Consultar nossa abrangência em /available. |
Requisição (curl)
POST https://api.capturaweb.com.br/v1/request
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| body | RequestBody | true | Objeto da requisição |
RequestBody
| 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 | Abaixo |
| callbacks | object | true | Abaixo |
param
| 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 |
Retorno (json)
| 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 |
Possiveis status da consulta
| Status | Descrição |
|---|---|
| pending | A consulta está sendo processada. |
| success | Crawler encontrou informações. |
| warning | Tribunal não encontrou dados. (Processo não existente, segredo de justiça…) |
| error | Ocorreu algum erro ao coletar os dados. (Indisponibilidade do tribunal, atualizado na página do sistema) |
Retorna lista de requisicoes
Para listar todas as consultas realizadas pelo usuário.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/request?source=courts&platform=esaj&search=tjba" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
params = {
'source': 'courts',
'platform': 'esaj',
'search': 'tjba',
}
response = requests.get('https://api.capturaweb.com.br/v1/request', params=params, headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/request?source=courts&platform=esaj&search=tjba');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/request?source=courts&platform=esaj&search=tjba',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"total": 1,
"result": [
{
"id": "e8361bc1-903e-4929-b96e-828d12ccc9e8",
"respondedAt": "2022-03-08T00:23:19.726Z",
"createdAt": "2022-03-08T00:23:07.485Z",
"platform": "esaj",
"status": "success",
"source": "courts",
"search": "tjba",
"query": "principal",
"param": {
"key": "cnj",
"value": "0500275-63.2017.8.05.0103"
}
}
]
}
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/request
Parâmetros | query string
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| source | string | false | Tipo da request: ex.: courts |
| platform | string | false | Plataforma da request: ex.: esaj |
| search | string | false | Tribunal da request: ex.: tjba |
| page | integer | false | Página: ex.: 1 |
| limit | integer | false | Limite por página: ex.: 25 |
| start | string | false | Data inicial da lista: ex.: 2019-10-01 |
| end | string | false | Data final da lista: ex.: 2019-11-20 |
| pending | boolean | false | Requisições pendentes |
| warning | boolean | false | Requisições com aviso |
| success | boolean | false | Requisições com a resposta |
| error | boolean | false | Requisições com algum erro |
Retorno (json)
| 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 |
Consultar pelo ID
Possibilita o acompanhamento de uma consulta realizada, através do ID gerado em uma nova consulta.
Requisição (curl)
GET https://api.capturaweb.com.br/v1/request/{requestId}
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c" \
-H "accept: */*" -H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
response = requests.get('https://api.capturaweb.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"type": "lawsuits",
"requested": {
"id": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
"status": "success",
"source": "courts",
"platform": "esaj",
"query": "principal",
"court": "tjsp",
"search": "tjsp",
"param": {
"key": "cnj",
"value": "0002796-14.2013.8.26.0323"
},
"respondedAt": "2022-03-08T00:26:37.603Z",
"createdAt": "2022-03-08T00:26:26.088Z"
},
"info": {
"source": "Consulta de Processos",
"platform": "eSAJ da Justiça Estadual",
"search": "Tribunal de Justiça de São Paulo",
"query": "Consulta de Processos de 1º Grau",
"paramKey": "Numeração Única"
},
"data": [
{
"cover": [
{
"description": "Processo",
"value": "0002796-14.2013.8.26.0323"
},
{
"description": "Classe",
"value": "Embargos à Execução"
},
{
"description": "Assunto",
"value": "DIREITO PROCESSUAL CIVIL E DO TRABALHO - Liquidação / Cumprimento / Execução - Efeito Suspensivo / Impugnação / Embargos à Execução"
},
{
"description": "Foro",
"value": "Foro de Lorena"
},
{
"description": "Vara",
"value": "1ª Vara Cível"
},
{
"description": "Juiz",
"value": "WALLACE GONCALVES DOS SANTOS"
},
{
"description": "Distribuição",
"value": "04/07/2014 às 09:37 - Direcionada"
},
{
"description": "Local Físico",
"value": "29/10/2019 00:00 - Arquivo Geral - 9001972171586"
},
{
"description": "Controle",
"value": "2014/002639"
},
{
"description": "Área",
"value": "Cível"
},
{
"description": "Valor da ação",
"value": "R$ 23.139,43"
},
{
"description": "Outros números",
"value": "032.32.0130.002796, 0002796-14.2013.8.26.0323"
}
],
"properties": {
"number": "0002796-14.2013.8.26.0323 - 032.32.0130.002796, 0002796-14.2013.8.26.0323",
"class": "Embargos à Execução",
"subject": "DIREITO PROCESSUAL CIVIL E DO TRABALHO - Liquidação / Cumprimento / Execução - Efeito Suspensivo / Impugnação / Embargos à Execução",
"origin": "Foro de Lorena",
"staff": "1ª Vara Cível",
"startAt": "2014-07-04T09:37:00.000Z",
"otherNumber": "2014/002639",
"path": "Cível",
"status": "Extinto",
"cnj": "0002796-14.2013.8.26.0323",
"value": "23139.43"
},
"people": [
{
"pole": "active",
"description": "Embargte",
"name": "Antonio XXXX XX XXXXXXX",
"lawyers": [
{
"name": "Geronimo Clezio dos Reis"
}
]
},
{
"pole": "passive",
"description": "Reqdo",
"name": "Hgvet Comercio de Produtos Agropecuarios e Veterinários Ltda Epp",
"lawyers": [
{
"name": "Renata de Cassia Castro Fonseca Cardoso"
},
{
"name": "Lucianne Fernandes Penin Garcia"
}
]
}
],
"steps": [
{
"timestamp": "2013-04-25T00:00:00.000Z",
"title": "Processo Distribuído Processo Distribuído por Dependência p/ 1ª. Vara Judicial",
"description": "Processo Distribuído por Dependência p/ 1ª. Vara Judicial"
},
{
"timestamp": "2013-04-26T00:00:00.000Z",
"title": "Recebimento de Carga Recebimento de Carga sob nº 9509558",
"description": "Recebimento de Carga sob nº 9509558"
},
...
{
"timestamp": "2019-10-25T00:00:00.000Z",
"description": "Arquivado Definitivamente"
},
{
"timestamp": "2019-10-25T00:00:00.000Z",
"title": "Trânsito em Julgado às partes - Proc. em Andamento 12/04/2019",
"description": "12/04/2019"
}
]
},
{
"cover": [],
"properties": {
"cnj": "3000689-43.2013.8.26.0323"
},
"people": [],
"steps": []
}
]
}Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| requestId | string | true | ID da request gerado em uma nova consulta. |
Retorno (json)
| 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 |
Callback
Nossa API de captura utiliza callback para retornar automaticamente o resultado de cada consulta realizada. No momento em que realizar uma nova consulta, basta informar uma url existente e válida no sistema do cliente. Caso a url seja inválida, inexistente ou estiver offline, nossa API retornará erro após atingir o máximo de tentativas de envio.
Retorno callback
{ “action”: “requestStatusChanged”, “requestId”: “”, “respondedAt”: “2019-11-01T07:00:00.944Z”, “status”: “success” }
Consulta automatica
Realizar uma NOVA consulta automatica
Realiza consultas automáticas por toda nossa abrangência de acordo com a justiça e tribunal vinculado ao número CNJ informado.
Exemplos
curl -X POST "https://api.capturaweb.com.br/v1/autorequest" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ" \
-H "Content-Type: application/json" \
-d "{\"key\":\"cnj\",\"value\":\"0804495-71.2018.8.10.0001\",\"callbacks\":[{\"method\":\"POST\",\"url\":\"http://callback.seudominio.com.br/\"}]}"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
json_data = {
'key': 'cnj',
'value': '0804495-71.2018.8.10.0001',
'callbacks': [
{
'method': 'POST',
'url': 'http://callback.seudominio.com.br/',
},
],
}
response = requests.post('https://api.capturaweb.com.br/v1/autorequest', headers=headers, json=json_data)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/autorequest');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"key":"cnj","value":"0804495-71.2018.8.10.0001","callbacks":[{"method":"POST","url":"http://callback.seudominio.com.br/"}]}');
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
'Content-Type': 'application/json'
};
var dataString = '{"key":"cnj","value":"0804495-71.2018.8.10.0001","callbacks":[{"method":"POST","url":"http://callback.seudominio.com.br/"}]}';
var options = {
url: 'https://api.capturaweb.com.br/v1/autorequest',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"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",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:42.857Z"
},
{
"id": "222f496a-0444-42d3-b9be-78f4927532ac",
"status": "pending",
"source": "courts",
"platform": "jurisconsult",
"query": "recursal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:43.440Z"
},
{
"id": "f2a9a200-c742-43e1-820c-a008e37ddce3",
"status": "pending",
"source": "courts",
"platform": "pje",
"query": "principal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:43.951Z"
},
{
"id": "d5d6615d-3327-4f73-801f-c94e456cf281",
"status": "pending",
"source": "courts",
"platform": "pje",
"query": "recursal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:44.576Z"
},
{
"id": "7e11cef3-53da-4deb-81bb-2e07244107de",
"status": "pending",
"source": "courts",
"platform": "superiores",
"query": "unificada",
"court": "stj",
"search": "stj",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:45.080Z"
}
],
"createdAt": "2022-03-08T01:06:42.664Z"
}
}Requisição (curl)
POST https://api.capturaweb.com.br/v1/autorequest
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| body | RequestBody | true | Objeto da requisição |
RequestBody
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| key | key string | true | Example: cnj |
| value | string | true | Example: 0500275-63.2017.8.05.0103 |
| makeDownload | boolean | false | Retorna link de arquivos anexados. Example: true |
| callbacks | object | true | Abaixo |
callbacks
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| method | string | true | Example: POST |
| url | string | true | Example: http://callback.seudominio.com.br |
Retorno (json)
| 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 |
Retorna lista de consultas automaticas realizadas
Retorna a lista de requisições automáticas geradas pelo usuário.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ" import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
params = {
'key': 'cnj',
'value': '0804495-71.2018.8.10.0001',
}
response = requests.get('https://api.capturaweb.com.br/v1/autorequest', params=params, headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"total": 2,
"result": [
{
"id": "c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9",
"key": "cnj",
"value": "0804495-71.2018.8.10.0001",
"createdAt": "2022-03-08T01:06:42.664Z",
"requests": [
{
"requestId": "7e11cef3-53da-4deb-81bb-2e07244107de"
},
{
"requestId": "471fd997-fa85-479e-a3a8-97d8391537bf"
},
{
"requestId": "222f496a-0444-42d3-b9be-78f4927532ac"
},
{
"requestId": "f2a9a200-c742-43e1-820c-a008e37ddce3"
},
{
"requestId": "d5d6615d-3327-4f73-801f-c94e456cf281"
}
]
},
{
"id": "dcbe1ecf-59c3-4016-be5c-8259816ee2a5",
"key": "cnj",
"value": "0804495-71.2018.8.10.0001",
"createdAt": "2022-03-08T01:00:24.315Z",
"requests": [
{
"requestId": "e660d7fd-4b47-4837-85e8-b877c9229324"
},
{
"requestId": "80f55a79-9dc2-423a-9ff3-a99281ed27ee"
},
{
"requestId": "b6ce4daa-1da3-42a9-9baf-0278584cdff3"
},
{
"requestId": "e729dd49-3319-4c6d-b7ba-3daaf7fbad36"
},
{
"requestId": "9429a876-7558-43fc-9d13-4670dd2524cd"
}
]
}
]
}
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/autorequest
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| key | string | false | Key válida: ex.: cnj |
| value | string | false | Valor de busca válido: ex.: 0804495-71.2018.8.10.0001 |
| page | integer | false | Página: ex.: 1 |
| limit | integer | false | Limite por página: ex.: 25 |
| start | string | false | Data inicial da lista: ex.: 2019-10-01 |
| end | string | false | Data final da lista: ex.: 2019-11-20 |
Retorno (json)
| 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 |
Retorna consulta automatica pelo ID
Retorna a lista de consultas automáticas geradas por ID.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
response = requests.get('https://api.capturaweb.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"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",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:42.857Z"
},
{
"id": "222f496a-0444-42d3-b9be-78f4927532ac",
"status": "pending",
"source": "courts",
"platform": "jurisconsult",
"query": "recursal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": null,
"createdAt": "2022-03-08T01:06:43.440Z"
},
{
"id": "f2a9a200-c742-43e1-820c-a008e37ddce3",
"status": "success",
"source": "courts",
"platform": "pje",
"query": "principal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": "2022-03-08T01:08:35.003Z",
"createdAt": "2022-03-08T01:06:43.951Z"
},
{
"id": "d5d6615d-3327-4f73-801f-c94e456cf281",
"status": "warning",
"source": "courts",
"platform": "pje",
"query": "recursal",
"court": "tjma",
"search": "tjma",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": "2022-03-08T01:08:08.956Z",
"createdAt": "2022-03-08T01:06:44.576Z"
},
{
"id": "7e11cef3-53da-4deb-81bb-2e07244107de",
"status": "warning",
"source": "courts",
"platform": "superiores",
"query": "unificada",
"court": "stj",
"search": "stj",
"param": {
"key": "cnj",
"value": "0804495-71.2018.8.10.0001"
},
"respondedAt": "2022-03-08T01:06:52.448Z",
"createdAt": "2022-03-08T01:06:45.080Z"
}
],
"createdAt": "2022-03-08T01:06:42.664Z"
}
}Requisição HTTP
GET https://api.capturaweb.com.br/v1/autorequest/{autoRequestId}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| autoRequestId | string | true | ID da autorequest a ser retornada |
Retorno (json)
| 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 |
Callback
Nossa API de captura utiliza callback para retornar automaticamente o resultado de cada consulta realizada. No momento em que realizar uma nova consulta, basta informar uma url existente e válida no sistema do cliente. Caso a url seja inválida, inexistente ou estiver offline, nossa API retornará erro após atingir o máximo de tentativas de envio.
Quando utilizar o endpoint /autorequest, será gerado retorno de callback individuais para cada consulta gerada pela nossa API, retornando em tempos diferentes.
Retorno callback
É o mesmo formato de um consulta individual.
Stats
Exibem informações estatísticas referentes ao consumo de consultas realizadas, em um período de data.
Retorna totais de consultas realizadas em todos os dias
Retorna lista com totais de consultas realizadas para métrica do consumo. É considerado todos os dias dentre o período informado, existindo ou não consultas realizadas.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/stats/use?start=2022-02-01&end=2022-02-02" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
params = {
'start': '2022-02-01',
'end': '2022-02-02',
}
response = requests.get('https://api.capturaweb.com.br/v1/stats/use', params=params, headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/stats/use?start=2022-02-01&end=2022-02-02');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/stats/use?start=2022-02-01&end=2022-02-02',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"today": {
"date": "2022-03-08",
"success": 5145,
"warning": 30,
"error": 0,
"pending": 3,
"total": 5178,
"bytes": 0
},
"days": [
{
"date": "2022-02-01",
"success": 8179,
"warning": 11,
"error": 1,
"pending": 0,
"total": 8191,
"bytes": 0
},
{
"date": "2022-02-02",
"success": 0,
"warning": 0,
"error": 0,
"pending": 0,
"total": 0,
"bytes": 0
},
.
.
.
]
}
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/stats/use
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| start | string | true | Data inicial da lista: ex.: 2022-02-01 |
| end | string | true | Data final da lista: ex.: 2022-02-02 |
Retorno (json)
| 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 |
Retorna totais de consultas apenas nos dias de execucao
Retorna lista com totais de consultas realizadas para métrica do consumo. É considerado apenas os dias dentre o período informado em que consultas foram realizadas.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/stats/consume?start=2022-02-01&end=2022-03-18" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
params = {
'start': '2022-02-01',
'end': '2022-03-18',
}
response = requests.get('https://api.capturaweb.com.br/v1/stats/consume', params=params, headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/stats/consume?start=2022-02-01&end=2022-03-18');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/stats/consume?start=2022-02-01&end=2022-03-18',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": [
{
"date": "2022-02-24",
"success": 1,
"warning": 2,
"error": 0,
"pending": 1,
"total": 4,
"bytes": 0
},
{
"date": "2022-03-04",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-07",
"success": 4,
"warning": 5,
"error": 3,
"pending": 0,
"total": 12,
"bytes": 0
},
{
"date": "2022-03-09",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-14",
"success": 6,
"warning": 0,
"error": 0,
"pending": 0,
"total": 6,
"bytes": 0
}
]
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/stats/consume
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| start | string | true | Data inicial da lista: ex.: 2022-02-01 |
| end | string | true | Data final da lista: ex.: 2022-03-18 |
Retorno (json)
| 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 |
Retorna totais com detalhes de consultas apenas nos dias de execucao
Retorna lista com totais de consultas realizadas para métrica do consumo. É considerado apenas os dias dentre o período informado em que consultas foram realizadas, apresentando alguns detalhes.
Exemplos
curl -X GET "https://api.capturaweb.com.br/v1/stats/details?start=2022-02-01&end=2022-03-18" \
-H "accept: */*" \
-H "Authorization: Bearer eyJhb…..57wxQ"import requests
headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ',
}
params = {
'start': '2022-02-01',
'end': '2022-03-18',
}
response = requests.get('https://api.capturaweb.com.br/v1/stats/details', params=params, headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/stats/details?start=2022-02-01&end=2022-03-18');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'accept': '*/*',
'Authorization': 'Bearer eyJhb…..57wxQ'
};
var options = {
url: 'https://api.capturaweb.com.br/v1/stats/details?start=2022-02-01&end=2022-03-18',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": [
{
"date": "2022-02-24",
"source": "lawsuits",
"platform": "esaj",
"search": "tjms",
"success": 0,
"warning": 0,
"error": 0,
"pending": 1,
"total": 1,
"bytes": 0
},
{
"date": "2022-02-24",
"source": "lawsuits",
"platform": "pje",
"search": "tjba",
"success": 0,
"warning": 1,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-02-24",
"source": "lawsuits",
"platform": "pje",
"search": "tjpr",
"success": 1,
"warning": 1,
"error": 0,
"pending": 0,
"total": 2,
"bytes": 0
},
{
"date": "2022-03-04",
"source": "lawsuits",
"platform": "custom",
"search": "tjrj",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-07",
"source": "lawsuits",
"platform": "esaj",
"search": "tjba",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-07",
"source": "lawsuits",
"platform": "esaj",
"search": "tjsp",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-07",
"source": "lawsuits",
"platform": "jurisconsult",
"search": "tjma",
"success": 0,
"warning": 1,
"error": 3,
"pending": 0,
"total": 4,
"bytes": 0
},
{
"date": "2022-03-07",
"source": "lawsuits",
"platform": "pje",
"search": "tjma",
"success": 2,
"warning": 2,
"error": 0,
"pending": 0,
"total": 4,
"bytes": 0
},
{
"date": "2022-03-07",
"source": "lawsuits",
"platform": "superiores",
"search": "stj",
"success": 0,
"warning": 2,
"error": 0,
"pending": 0,
"total": 2,
"bytes": 0
},
{
"date": "2022-03-09",
"source": "lawsuits",
"platform": "projudi",
"search": "tjpr",
"success": 1,
"warning": 0,
"error": 0,
"pending": 0,
"total": 1,
"bytes": 0
},
{
"date": "2022-03-14",
"source": "lawsuits",
"platform": "jurisconsult",
"search": "tjma",
"success": 6,
"warning": 0,
"error": 0,
"pending": 0,
"total": 6,
"bytes": 0
}
]
}Requisição (curl)
GET https://api.capturaweb.com.br/v1/stats/details
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| start | string | true | Data inicial da lista: ex.: 2022-02-01 |
| end | string | true | Data final da lista: ex.: 2022-03-18 |
Retorno (json)
| 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 |
CDN
Armazena os arquivos públicos obtidos através dos dados públicos consultados.
Se a consulta encontrar em arquivo público, o robô realiza o download e armazena em nosso CDN. A url do CDN é informada no JSON de retorno dentro dos steps.
Requisição (curl)
GET https://cdn.codilo.net.br/files/[ARQUIVO]
Monitoramento de Processos
O Monitoramento de Processos foi desenvolvido para receber as novas atualizações dos processos nos tribunais.
Cadastrar um novo processo
Cadastra um novo processo a ser consultado diariamente.
Será pesquisado em todas as instâncias disponíveis em nossa API.
obs.: para não receber callback ou já deixar confirmado todos os dados capturados anterior a data de cadastro do processo, enviar a propriedade ignore como true.
obs-2.: podes enviar headers customizados para receber de nossos envios.
Todos os envios terão o header: ‘User-Agent’: ‘CodiloCallback/1.0 (+http://codilo.com.br/)’
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/processo/novo \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{
"cnj": "0030779-57.2015.8.10.0001",
"ignore": false,
"callbacks": [
{
"method": "POST",
"url": "https://callback.seudominio.com.br",
"headers": {
"My-Custom-Header": "My-Custom-Header-Value"
}
}
]
}'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json',
}
json_data = {
'cnj': '0030779-57.2015.8.10.0001',
'ignore': False,
'callbacks': [
{
'method': 'POST',
'url': 'https://callback.seudominio.com.br',
'headers': {
'My-Custom-Header': 'My-Custom-Header-Value',
},
},
]
}
response = requests.post('https://api.push.codilo.com.br/v1/processo/novo', headers=headers, json=json_data)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/novo');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n \"cnj\": \"0030779-57.2015.8.10.0001\",\n \"ignore\": false,\n \"callbacks\": [\n {\n \"method\": \"POST\",\n \"url\": \"https://callback.seudominio.com.br\",\n \"headers\": {\n \"My-Custom-Header\": \"My-Custom-Header-Value\"\n }\n }\n ]\n}");
$response = curl_exec($ch);
curl_close($ch);fetch('https://api.push.codilo.com.br/v1/processo/novo', {
method: 'POST',
headers: {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
},
body: JSON.stringify({
'cnj': '0030779-57.2015.8.10.0001',
'ignore': false,
'callbacks': [
{
'method': 'POST',
'url': 'https://callback.seudominio.com.br',
'headers': {
'My-Custom-Header': 'My-Custom-Header-Value'
}
}
]
})
});{
"success": true,
"data": {
"id": "43e595f8-716f-464b-9c2a-5c4318bd787c",
"cnj": "0030779-57.2015.8.10.0001",
"createdAt": "2022-03-11T13:16:52.894Z",
"credentials": false,
"info": [
{
"id": "796f03a3-3468-4c80-b515-8192b495b2bf",
"source": "Consulta de Tribunais",
"platform": "Jurisconsult",
"search": "Tribunal de Justiça do Maranhão",
"query": "Consulta de Processos de 1º Grau"
},
{
"id": "c248cddf-f3f9-448d-9e7e-5f55122765c7",
"source": "Consulta de Tribunais",
"platform": "Jurisconsult",
"search": "Tribunal de Justiça do Maranhão",
"query": "Consulta de Processos de 2º Grau"
},
{
"id": "35490614-b905-4cda-94df-e4c02ce3d877",
"source": "Consulta de Tribunais",
"platform": "PJe da Justiça Estadual",
"search": "Tribunal de Justiça do Maranhão",
"query": "Consulta de Processos de 1º Grau"
},
{
"id": "0e59e5ff-a698-4ca0-abd4-878acbeaf56d",
"source": "Consulta de Tribunais",
"platform": "PJe da Justiça Estadual",
"search": "Tribunal de Justiça do Maranhão",
"query": "Consulta de Processos de 2º Grau"
}
]
}
}Requisição (curl)
POST https://api.push.codilo.com.br/v1/processo/novo
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cnj | string-cnj | true | Número válido do Processo em formato padrão CNJ |
| callbacks | array | false | URL de callback com o método e header customizado |
| ignore | boolean | false | Propriedade para ignorar dados anterior ao cadastro |
| credentials | object | false | Autenticação para Segredo de Justiça. Detalhes abaixo |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Invalid CNJ | “value” must be “cnj” | |
| 401 | Unauthorized | Access denied | None |
Cadastrar varios processos
Em breve
Exemplos
{}Requisição (curl)
POST url
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
Lista de processos monitorados
Retorna a lista de processos cadastrados no monitoramento.
Exemplos
curl --request GET \
--url https://api.push.codilo.com.br/v1/processo/listar \
--header 'Authorization: Bearer eyJh...hBA'import requests
headers = {
'Authorization': 'Bearer eyJh...hBA',
}
response = requests.get('https://api.push.codilo.com.br/v1/processo/listar', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/listar');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...hBA',
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...hBA'
};
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/listar',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"totalItems": 2,
"currentPage": 1,
"pageSize": 25,
"totalPages": 1,
"list": [
{
"id": "43e595f8-716f-464b-9c2a-5c4318bd787c",
"cnj": "0030779-57.2015.8.10.0001",
"createdAt": "2022-03-11T13:16:53.372Z"
},
{
"id": "ced67beb-29fd-45dd-b12f-79ae260f9be0",
"cnj": "0001716-28.1990.8.11.0003",
"createdAt": "2022-03-11T13:14:46.805Z"
}
]
}
}Requisição (curl)
GET https://api.push.codilo.com.br/v1/processo/listar
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| value | string | false | Valor de busca válido: ex.: 0804495-71.2018.8.10.0001 |
| page | integer | false | Página: ex.: 1 |
| limit | integer | false | Limite por página: ex.: 25 |
| start | string | false | Data inicial da lista: ex.: 2019-10-01 |
| end | string | false | Data final da lista: ex.: 2019-11-20 |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
Informacoes de cadastramento do processo pelo ID
Dados de localização do processo pelo ID.
Exemplos
curl --request GET \
--url https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5 \
--header 'Authorization: Bearer eyJh...J-w'import requests
headers = {
'Authorization': 'Bearer eyJh...J-w',
}
response = requests.get('https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...J-w',
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...J-w'
};
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"id": "0eee9c0a-b96f-488f-84d3-15c8452ef0b5",
"cnj": "0001716-28.1990.8.11.0003",
"createdAt": "2022-03-10T20:31:53.427Z",
"info": [
{
"id": "a7ce3f76-1a74-4069-bef8-b33e53cc4b97",
"source": "Consulta de Tribunais",
"platform": "Tribunais Superiores",
"search": "Tribunal Superior do Trabalho",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "superiores",
"searchTag": "tst",
"queryTag": "unificada",
"lastStatus": "success",
"lastResponse": "2023-07-11T06:19:45.662Z",
"disabled": false
},
{
"id": "3554f2f1-de69-4df3-b2c2-8e8cb4852ae6",
"source": "Consulta de Tribunais",
"platform": "Tribunais Superiores",
"search": "Supremo Tribunal Federal",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "superiores",
"searchTag": "stf",
"queryTag": "unificada",
"lastStatus": "success",
"lastResponse": "2023-07-11T06:19:45.673Z",
"disabled": false
}
]
}
}Requisição HTTP
GET https://api.push.codilo.com.br/v1/processo/info/{processoId}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| processoId | string | true | ID do processo a ser retornado |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
| 500 | Internal Server error | Result cannot be resolved | None |
Dados do processo cadastrado
Dados do processo pelo ID.
Será retornado um array com todos as informações coletadas das fontes que pesquisamos.
Capa do Processo: cover: [{id: ‘uuidV4’, description: ‘string’, value: ‘string’}]
Propriedades do Processo: propertiesArray: [{id: ‘uuidV4’, key: ‘string’, value: ‘string’}]
Partes do Processo: people: [{id: ‘uuidV4’, pole: ‘string’, description: ‘string’, name: ‘string’}, lawyers: [{name: ‘string’, oab: ‘123’, uf: ‘SP’}]]
Andamentos do Processo: steps: [{id: ‘uuidV4’, title: ‘string’, description: ‘string’, files: []}]
Exemplos
curl --request GET \
--url https://api.push.codilo.com.br/v1/processo/dados/49409db8-aef0-4ed7-b679-170055a63ff3 \
--header 'Authorization: Bearer eyJh...J-w'import requests
headers = {
'Authorization': 'Bearer eyJh...J-w',
}
response = requests.get('https://api.push.codilo.com.br/v1/processo/dados/49409db8-aef0-4ed7-b679-170055a63ff3', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/dados/49409db8-aef0-4ed7-b679-170055a63ff3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...J-w',
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...J-w'
};
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/dados/49409db8-aef0-4ed7-b679-170055a63ff3',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"id": "49409db8-aef0-4ed7-b679-170055a63ff3",
"cnj": "0001716-28.1990.8.11.0003",
"createdAt": "2022-03-10T20:31:53.427Z",
"info": [
{
"id": "d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"source": "Consulta de Tribunais",
"platform": "Tribunais Superiores",
"search": "Conselho Nacional de Justiça",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "superiores",
"searchTag": "cnj",
"queryTag": "unificada",
"lastStatus": "success",
"lastResponse": "2023-07-12T15:31:09.500Z",
"disabled": false,
"data": [{ "cover": [], "propertiesArray": [], "properties": {}, "people": [], "steps": [] }],
},
{
"id": "5ec4d534-b269-4d19-980a-5cbab5ff870b",
"source": "Consulta de Tribunais",
"platform": "Tribunais Superiores",
"search": "Superior Tribunal de Justiça",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "superiores",
"searchTag": "stj",
"queryTag": "unificada",
"lastStatus": "success",
"lastResponse": "2023-07-11T08:30:03.942Z",
"disabled": false,
"data": [{ "cover": [], "propertiesArray": [], "properties": {}, "people": [], "steps": [] }],
}
]
}
}Requisição HTTP
GET https://api.push.codilo.com.br/v1/processo/dados/{processoIdOuCNJ}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| processoIdOuCNJ | string | true | ID do processo a ser retornado, ou o número CNJ cadastrado (deve ser enviado sem pontuação) |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
| 500 | Internal Server error | Result cannot be resolved | None |
Apagar um processo cadastrado
Parar de monitorar o processo cadastrado.
Exemplos
curl --request DELETE \
--url https://api.push.codilo.com.br/v1/processo/excluir/49409db8-aef0-4ed7-b679-170055a63ff3 \
--header 'Authorization: Bearer eyJh...oPmQ'import requests
headers = {
'Authorization': 'Bearer eyJh...oPmQ',
}
response = requests.delete('https://api.push.codilo.com.br/v1/processo/excluir/49409db8-aef0-4ed7-b679-170055a63ff3', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/excluir/49409db8-aef0-4ed7-b679-170055a63ff3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...oPmQ',
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...oPmQ'
};
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/excluir/49409db8-aef0-4ed7-b679-170055a63ff3',
method: 'DELETE',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true
}Requisição HTTP
DELETE https://api.push.codilo.com.br/v1/processo/excluir/{processoId}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| processoId | string | true | ID do processo a ser apagado |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
Confirmar leitura item
Confirmar a leitura/salvamento dos dados retornados.
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/confirmar \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{ "cnjId": "item-uuidv4", "coverIds": ["item-uuidv4", "item-uuidv4", "item-uuidv4"] }'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
}
json_data = {
'cnjId': 'item-uuidv4', 'coverIds': ['item-uuidv4', 'item-uuidv4', 'item-uuidv4'],
}
response = requests.post('https://api.push.codilo.com.br/v1/confirmar', headers=headers, json=json_data)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/confirmar');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "cnjId": "item-uuidv4", "coverIds": ["item-uuidv4", "item-uuidv4", "item-uuidv4"] }');
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
};
var dataString = '{ "cnjId": "item-uuidv4", "coverIds": ["item-uuidv4", "item-uuidv4", "item-uuidv4"] }';
var options = {
url: 'https://api.push.codilo.com.br/v1/confirmar',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"cnjId": "bc74ac7d-acfc-4daa-98e8-6238c1ffe03b",
"coverIds": [
"29d22970-b12a-4c3b-b5f6-f6b1774d6aa3"
],
"propertyIds": [
"26fce6c8-ac05-4ca4-901c-32a89e6ef1cb",
"f8d7d421-04dd-4e94-817c-80c823603664",
"ad15c5ad-3f24-4025-aac4-b8cce20caf2b",
"022bc9e8-3eec-4da5-bd55-58704fe63cb5",
"a3a661ea-ca4f-4eb2-8391-4920dd858b74",
"81c96fc1-2ca7-4ed4-a9d0-0e76bc5b676e"
],
"personIds": [
"b4b316f8-be40-4da3-9679-84b7c265dd07",
"3e747449-d29d-4550-9296-4ed75ca79770"
],
"stepIds": [
"895e87ba-5b67-4a4a-920d-422be26354e6",
"8cd91886-4d43-418c-8fdb-3006c57a9451",
"aaaa8d8f-27ee-4a6e-a886-0c5206e7b807",
"53662e1e-56e8-4d11-b291-03741f9421a7"
]
}
}Requisição HTTP
POST https://api.push.codilo.com.br/v1/confirmar
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cnjId | uuid | true | ID do processo a ser confirmado os dados |
| coverIds | array | false | IDs de cada objeto de capa |
| propertyIds | array | false | IDs de cada objeto de propriedade |
| personIds | array | false | IDs de cada objeto de partes |
| stepIds | array | false | IDs de cada objeto de andamento |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
| 500 | Internal Server error | Result cannot be resolved | None |
Reportar inconsistencias
Reportar qualquer inconsistência nos dados capturados de forma automatizada.
Pode ser adicionado qualquer título e descrição,
Recomendamos a padronização dos reportes de forma automazida.
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/processo/reportar/2ed4c9b1-dfdf-4c05-8adb-565eee6c433d \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{ "title": "Título Exemplo", "description": "Descrição Exemplo", "priority": "4", "type": "bug" }'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
}
json_data = {
'title': 'Título Exemplo'
'description': 'Descrição Exemplo'
'priority': '4'
'type': 'bug'
}
response = requests.post('https://api.push.codilo.com.br/v1/processo/reportar/2ed4c9b1-dfdf-4c05-8adb-565eee6c433d', headers=headers, json=json_data)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/reportar/2ed4c9b1-dfdf-4c05-8adb-565eee6c433d');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{ \"title\": \"Título Exemplo\", \"description\": \"Descrição Exemplo\", \"priority\": \"4\", \"type\": \"bug\" }");
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
};
var dataString = '{ "title": "Título Exemplo", "description": "Descrição Exemplo", "priority": "4", "type": "bug" }';
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/reportar/2ed4c9b1-dfdf-4c05-8adb-565eee6c433d',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"hash": "64cbc4a3",
"title": "Título Exemplo",
"description": "Descrição do Exemplo",
"priority": "4",
"type": "bug"
}
}Requisição HTTP
POST https://api.push.codilo.com.br/v1/processo/reportar/{processoId}
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| title | string | true | Titulo do reporte |
| description | string | true | Descrição do reporte |
| priority | string | true | Número de prioridade: 1-4 |
| type | string | true | Tipo do reporte: bug ou feature |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
| 500 | Internal Server error | Result cannot be resolved | None |
Itens pendentes
Checar se há novos registros não salvos/recebidos a partir de um número CNJ ou por seu ID cadastrado.
Dentro de cada objeto virá a flag “confirmed”: false.
- Resultado será paginado. Caso não passe parametros cnjId ou cnj, será retornado todos os processos cadastrados que contém itens pendentes a confirmação.
Exemplos
curl --request GET \
--url https://api.push.codilo.com.br/v1/pendentes?cnjId=uuidV4&limit=2 \
--header 'Authorization: Bearer eyJh...J-w'import requests
headers = {
'Authorization': 'Bearer eyJh...J-w',
}
response = requests.get('https://api.push.codilo.com.br/v1/pendentes?cnjId=uuidV4&limit=2', headers=headers)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.capturaweb.com.br/v1/pendentes?cnjId=uuidV4&limit=2');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'accept: */*',
"Authorization: Bearer eyJhb…..57wxQ",
]);
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...J-w'
};
var options = {
url: 'https://api.push.codilo.com.br/v1/pendentes?cnjId=uuidV4&limit=2',
headers: headers
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"totalItems": 180,
"currentPage": 1,
"pageSize": 2,
"totalPages": 90,
"list": [
{
"id": "2ed4c9b1-dfdf-4c05-8adb-565eee6c433d",
"cnj": "0102133-84.2017.5.01.0483",
"ignore": false,
"createdAt": "2022-08-06T11:57:18.910Z",
"info": [
{
"id": "7aa09fde-7f81-46b4-a859-0f0067200e38",
"source": "Consulta de Tribunais",
"platform": "Plataforma Personalizada",
"search": "Tribunal Regional do Trabalho da 1ª Região",
"query": "Consulta de Processos de 1º e 2º Grau",
"sourceTag": "courts",
"platformTag": "custom",
"searchTag": "trt1",
"queryTag": "unificada",
"lastResponse": "2022-11-30T15:00:16.845Z",
"data": []
},
{
"id": "69f6e1d0-3e50-4432-b41d-b85cc8d24c6d",
"source": "Consulta de Tribunais",
"platform": "PJe da Justiça do Trabalho",
"search": "Tribunal Regional do Trabalho da 1ª Região",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "pje-jt",
"searchTag": "trt1",
"queryTag": "unificada",
"lastResponse": "2022-11-30T15:01:43.433Z",
"data": [
{
"cover": [
{
"id": "8b70294c-63c0-4117-89af-fa38486d0405",
"description": "Orgão Julgador",
"value": "3ª Vara do Trabalho de Macaé",
"index": "0",
"confirmed": false
},
{
"id": "df82f88a-8165-4936-bfb0-13afb092e453",
"description": "Grau",
"value": "1",
"index": "0",
"confirmed": false
}
],
"steps": [
{
"id": "e54389b6-e0bb-4591-8f6d-0e0dab9f4f13",
"timestamp": "2018-03-13T15:26:58.000Z",
"title": null,
"description": "Ata da Audiência | Ata da Audiência",
"actionBy": null,
"index": "0",
"confirmed": false
},
{
"id": "a2b92490-034c-4383-adc4-9f7264773383",
"timestamp": "2018-12-18T09:19:39.000Z",
"title": null,
"description": "Arquivados os autos definitivamente",
"actionBy": null,
"index": "0",
"confirmed": false
}
]
}
]
},
{
"id": "654d7b81-1f31-4249-90bc-2d6009db2f3a",
"source": "Consulta de Tribunais",
"platform": "PJe da Justiça do Trabalho v2",
"search": "Tribunal Regional do Trabalho da 1ª Região",
"query": "Consulta de Processos Unificada",
"sourceTag": "courts",
"platformTag": "pje-jt-web",
"searchTag": "trt1",
"queryTag": "unificada",
"lastResponse": "2022-11-30T15:00:33.309Z",
"data": [
{
"steps": [
{
"id": "00c4b6c8-39dd-46e9-854b-c2a5b66b1a2d",
"timestamp": "2017-10-11T16:04:29.831Z",
"title": null,
"description": "Distribuído por sorteio",
"actionBy": null,
"index": "0",
"confirmed": false
}
]
}
]
}
]
},
{
"id": "e19272d3-e6f2-4c21-b6cd-8b76063e3b3a",
"cnj": "0000001-05.2008.8.16.0027",
"ignore": false,
"createdAt": "2022-08-08T15:49:22.489Z",
"info": [
{
"id": "955dff51-18f5-4855-aac8-a1830cb9394b",
"source": "Consulta de Tribunais",
"platform": "PJe da Justiça Estadual",
"search": "Tribunal de Justiça do Paraná",
"query": "Consulta de Processos de 2º Grau",
"sourceTag": "courts",
"platformTag": "pje",
"searchTag": "tjpr",
"queryTag": "recursal",
"lastResponse": "2022-11-13T23:04:13.411Z",
"data": []
},
{
"id": "2ec78bc6-652c-40f9-bd9f-aa921c2f1159",
"source": "Consulta de Tribunais",
"platform": "Projudi da Justiça Estadual",
"search": "Tribunal de Justiça do Paraná",
"query": "Consulta de Processos de 1º Grau",
"sourceTag": "courts",
"platformTag": "projudi",
"searchTag": "tjpr",
"queryTag": "principal",
"lastResponse": "2022-11-30T15:02:15.320Z",
"data": [
{
"cover": [
{
"id": "14341bba-34aa-4023-ae7f-31db2738bcda",
"description": "Classe Processual",
"value": "436 - Procedimento do Juizado Especial Cível",
"index": "0",
"confirmed": false
},
{
"id": "2e7fec96-ca4b-4356-98ff-64ec124ce1f0",
"description": "Assunto Principal",
"value": "7717 - Espécies de Títulos de Crédito",
"index": "0",
"confirmed": false
},
{
"id": "ef713d06-856c-49fa-bf75-067f59cb3aae",
"description": "Comarca",
"value": "Campo Largo",
"index": "0",
"confirmed": false
},
{
"id": "237a7e8a-aa19-4c34-836d-d8ad58b1bb26",
"description": "Status",
"value": "ARQUIVADO",
"index": "0",
"confirmed": false
}
]
}
]
},
{
"id": "2008828b-6a96-41e0-8416-aa458802f409",
"source": "Consulta de Tribunais",
"platform": "Projudi da Justiça Estadual",
"search": "Tribunal de Justiça do Paraná",
"query": "Consulta de Processos de 2º Grau",
"sourceTag": "courts",
"platformTag": "projudi",
"searchTag": "tjpr",
"queryTag": "recursal",
"lastResponse": "2022-11-30T15:00:58.408Z",
"data": []
}
]
}
]
}
}Requisição HTTP
GET https://api.push.codilo.com.br/v1/pendentes
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cnjId | uuid | false | ID do número CNJ cadastrado |
| cnj | string | false | Número CNJ cadastrado |
| page | number | false | Número da página |
| limit | number | false | Quantidade de itens por página (1-200) |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
| 500 | Internal Server error | Result cannot be resolved | None |
Callback
Nossa API de monitoramento (push) utiliza callback para retornar automaticamente o resultado de cada processo monitorado. No momento em que cadastrar um processo para ser monitorado, basta informar uma url existente e válida no sistema do cliente. Caso a url seja inválida, inexistente ou estiver offline, nossa API retornará erro após atingir o máximo de tentativas de envio.
O callback será enviado sempre que alguma modificação no processo for encontrada.
Retorno callback
{
“id”: “”,
“cnj”: “”,
“ignore”: false,
“createdAt”: “2022-11-28T11:56:28.753Z”,
“info”: [
{
“id”: “”,
“source”: “Consulta de Tribunais”,
“platform”: “Plataforma Personalizada”,
“search”: “Tribunal de Justiça do Estado do Paraná Juizado Especial”,
“query”: “Consulta de Processos Unificada”,
“sourceTag”: “courts”,
“platformTag”: “custom”,
“searchTag”: “tjpr-juizesp”,
“queryTag”: “unificada”,
“lastResponse”: “2023-01-01T23:43:45.865Z”,
“data”: []
},
{
“id”: “”,
“source”: “Consulta de Tribunais”,
“platform”: “Projudi da Justiça Estadual”,
“search”: “Tribunal de Justiça do Paraná”,
“query”: “Consulta de Processos de 1º Grau”,
“sourceTag”: “courts”,
“platformTag”: “projudi”,
“searchTag”: “tjpr”,
“queryTag”: “principal”,
“lastResponse”: “2023-01-01T23:31:59.938Z”,
“data”: [
{
“cover”: [
{
“id”: “”,
“description”: “Processo”,
“value”: “”,
“index”: “0”,
“confirmed”: false
},
{
“id”: “”,
“description”: “Classe Processual”,
“value”: “”,
“index”: “0”,
“confirmed”: false
}
],
“properties”: {
“number”: “”,
“class”: “436 - Procedimento do Juizado Especial Cível”,
“subject”: “”,
“district”: “”,
“origin”: “Juizado Especial Cível”,
“startAt”: “2022-11-25T15:00:35.000Z”,
“judge”: “”,
“cnj”: “”
},
“propertiesArray”: [
{
“id”: “”,
“key”: “number”,
“value”: “”,
“index”: “0”,
“confirmed”: false
}
],
“people”: [
{
“id”: “”,
“pole”: “passive”,
“description”: null,
“name”: “EMPRESA S/A”,
“doc”: null,
“index”: “0”,
“confirmed”: false,
“lawyers”: []
}
],
“steps”: [
{
“id”: “”,
“timestamp”: “2022-11-25T15:00:35.000Z”,
“title”: “JUNTADA DE PETIÇÃO DE INICIAL”,
“description”: null,
“actionBy”: “”,
“index”: “0”
},
{
“id”: “”,
“timestamp”: “2022-11-25T15:00:35.000Z”,
“title”: “AUTOS INCLUÍDOS NO JUÍZO 100% DIGITAL”,
“description”: null,
“actionBy”: “”,
“index”: “0”
}
]
}
]
}
]
}
Desativar abrangencias
É possível desativar abrangências de um determinado CNJ.
Ao desativar ele não será listado em Itens pendentes e não será enviado no callback
É possível verificar se a abrangência está ativa ou não em Informações de cadastramento do processo pelo ID e em Dados do processo cadastrado
Ex: O processo foi cadastrado e o tribunal possui 3 plataformas para realizar a busca (PJe, eSAJ e Projudi). Essa funcionalidade serve para deixar ativo somente a plataforma que o usuário necessite dos dados. No caso, desabilitar as plataformas eSAJ e Projudi, e manter ativo o monitoramento somente no PJe.
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/desativar \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{
"infoIds": [
"d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"casd2979-bb52-4967-ac7e-02cdec250b38"
]
}'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json',
}
json_data = {
'infoIds': [
'd0af2a37-ed4e-485b-ad60-1fb0760ae35b',
'casd2979-bb52-4967-ac7e-02cdec250b38',
],
}
response = requests.post(
'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/desativar',
headers=headers,
json=json_data,
)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/desativar');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{ \n\t\t\"infoIds\": [\n\t\t\t\"d0af2a37-ed4e-485b-ad60-1fb0760ae35b\", \n\t\t\t\"casd2979-bb52-4967-ac7e-02cdec250b38\"\n\t\t\t] \n\t\t}");
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
};
var dataString = '{"infoIds": ["d0af2a37-ed4e-485b-ad60-1fb0760ae35b", "casd2979-bb52-4967-ac7e-02cdec250b38"]}';
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/desativar',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": [
{
"infoId": "d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"message": "desativado"
},
{
"infoId": "casd2979-bb52-4967-ac7e-02cdec250b38",
"message": "desativado"
}
]
}Requisição (curl)
POST https://api.push.codilo.com.br/v1/processo/info/{processoId}/desativar
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| infoIds | array | true | Lista de id das infos |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
Ativar abrangencias
É possível reativar abrangências de um determinado CNJ.
Ao reativar ele voltará a ser listado em Itens pendentes e será enviado no callback
É possível verificar se a abrangência está ativa ou não em Informações de cadastramento do processo pelo ID e em Dados do processo cadastrado
Ex: O processo foi cadastrado e o tribunal possui 3 plataformas para realizar a busca (PJe, eSAJ e Projudi). Essa funcionalidade serve para deixar ativo somente a plataforma que o usuário necessite dos dados. No caso, desabilitar as plataformas eSAJ e Projudi, e manter ativo o monitoramento somente no PJe.
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/ativar \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{
"infoIds": [
"d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"casd2979-bb52-4967-ac7e-02cdec250b38"
]
}'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json',
}
json_data = {
'infoIds': [
'd0af2a37-ed4e-485b-ad60-1fb0760ae35b',
'casd2979-bb52-4967-ac7e-02cdec250b38',
],
}
response = requests.post(
'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/ativar',
headers=headers,
json=json_data,
)<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/ativar');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{ \n\t\t\"infoIds\": [\n\t\t\t\"d0af2a37-ed4e-485b-ad60-1fb0760ae35b\", \n\t\t\t\"casd2979-bb52-4967-ac7e-02cdec250b38\"\n\t\t\t] \n\t\t}");
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
};
var dataString = '{"infoIds": ["d0af2a37-ed4e-485b-ad60-1fb0760ae35b", "casd2979-bb52-4967-ac7e-02cdec250b38"]}';
var options = {
url: 'https://api.push.codilo.com.br/v1/processo/info/0eee9c0a-b96f-488f-84d3-15c8452ef0b5/ativar',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": [
{
"infoId": "d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"message": "ativado"
},
{
"infoId": "casd2979-bb52-4967-ac7e-02cdec250b38",
"message": "ativado"
}
]
}Requisição (curl)
POST https://api.push.codilo.com.br/v1/processo/info/{processoId}/ativar
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| infoIds | array | true | Lista de id das infos |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |
Testar callback
Nossa api fornece uma rota que retorna um modelo padrão de resposta do monitoramento para que você possa testar o funcionamento do seu callback.
Obs.: O retorno de produção possui valores diferentes mas seguindo o mesmo padrão.
Exemplos
curl --request POST \
--url https://api.push.codilo.com.br/v1/teste/callback \
--header 'Authorization: Bearer eyJh...s-82g' \
--header 'Content-Type: application/json' \
--data '{
"url": "http://callback.codilo.net.br/teste",
"headers": {
"header-teste": "123456",
"abc": "def"
}'import requests
headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json',
}
data = '{ \n\t\t"url": "http://callback.codilo.net.br/teste",\n\t\t"headers": {\n\t\t\t"header-teste": "123456",\n\t\t\t"abc": "def"\n\t\t}'
response = requests.post('https://api.push.codilo.com.br/v1/teste/callback', headers=headers, data=data)
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.push.codilo.com.br/v1/teste/callback');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer eyJh...s-82g',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{ \n\t\t\"url\": \"http://callback.codilo.net.br/teste\",\n\t\t\"headers\": {\n\t\t\t\"header-teste\": \"123456\",\n\t\t\t\"abc\": \"def\"\n\t\t}");
$response = curl_exec($ch);
curl_close($ch);var request = require('request');
var headers = {
'Authorization': 'Bearer eyJh...s-82g',
'Content-Type': 'application/json'
};
var dataString = '{"url": "http://callback.codilo.net.br/teste","headers": { "header-teste": "123456", "abc": "def"}';
var options = {
url: 'https://api.push.codilo.com.br/v1/teste/callback',
method: 'POST',
headers: headers,
body: dataString
};
function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
}
request(options, callback);{
"success": true,
"data": {
"url": "http://callback.codilo.net.br/teste",
"headers": {
"header-teste": "123456",
"abc": "def"
},
"method": "POST"
}
}Requisição (curl)
POST https://api.push.codilo.com.br/v1/teste/callback
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| url | string | true | Url do callback |
| headers | object | false | Headers que seu callback precisa |
Retorno (json)
| Status | Significado | Descrição | Schema |
|---|---|---|---|
| 200 | OK | Sucesso | None |
| 401 | Unauthorized | Access denied | None |