Saneamento de base¶
API para saneamento automatizado de base de dados judicial.
O fluxo de funcionamento é:
- Criar e Encomendar relatório informando os números CNJs que devem constar no relatório;
- Receber aviso de que relatório foi finalizado;
- Consultar dados consolidados do relatório, ou dados detalhados dos processos em JSON ou Excel.
Nota
Processos em segredo de justiça não são retornados por esta API.
Nota
Apenas processos não atualizados há mais de 4 dias serão incluídos no relatório de saneamento de base. Processos atualizados nos últimos 4 dias serão considerados já atualizados.
Prazos para conclusão dos relatórios¶
Dependemos da estabilidade dos tribunais para realizar a atualização dos processos. Um relatório com até 600 processos leva em média 48h para ficar pronto. Um relatório de 40.000 processos leva em média 240h.
O número máximo de processos permitido por relatório é de 40.000.
Criar um relatório¶
-
POSThttps://op.digesto.com.br/api/virtual_report/create_virtual_report¶ Cria um novo relatório de saneamento de base com os cnjs que devem constar nele, retornando o id do relatório. [Código do Produto:
PCS_UN_RelatorioProcsPorNumero]Nota
Requer módulo “(IP/API) Relatórios: relatório de saneamento por número”
Exemplo de chamada:
POST https://op.digesto.com.br/api/virtual_report/create_virtual_report HTTP/1.1 Content-Type: application/json { "cnjs":[ "8001084-35.2022.8.05.0220", "1001697-33.2022.5.02.0084", "0015595-07.1999.4.02.5101" ] }
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json 81801
Request JSON Object: - cnjs (object) – Os cnjs que devem ser atualizados.
Response JSON Object: - integer – ID do relatório. Deve ser armazenado pois será usado nos próximos passos do fluxo.
Obter dados prévios consolidados de um relatório¶
-
GEThttps://op.digesto.com.br/api/virtual_report/(id do relatorio)/preview_virtual_report¶ Traz quais processos inseridos foram encontrados no tribunal
Nota
Requer módulo “(IP/API) Relatórios: relatório de saneamento por número”
Exemplo de chamada:
GET https://op.digesto.com.br/api/virtual_report/81801/preview_virtual_report HTTP/1.1 Accept: application/json
Exemplo de resposta:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "invalid_cnjs":[ ], "name":"Relat\u00f3rio de Saneamento de Base (19/12/22)", "total_valid_cnjs":3, "valid_cnjs":[ "80010843520228050220", "10016973320225020084", "155950719994025101" ] }
Parameters: - relatorio_id – ID Digesto do relatório
Response JSON Object: - invalid_cnjs – Lista com os cnjs inválidos, caso tenha algum.
- name – Nome do relatório.
- total_valid_cnjs – Total de CNJS válidos.
- valid_cnjs – Lista com os cnjs válidos.
Associando um relatório com um centro de custo¶
-
POSThttps://op.digesto.com.br/api/virtual_report/(id do relatorio)/set_billing_code¶ É possível associar um centro de custo com um relatório em especifico.
Exemplo de chamada:
POST https://op.digesto.com.br/api/virtual_report/81801/set_billing_code HTTP/1.1 Content-Type: application/json {"billing_code_name":"Centro de custo"}
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json 4926
Request JSON Object: - id (integer) – ID Digesto do relatório.
- billing_code_name (string) – Nome do centro de custo.
Response JSON Object: - id_centro_de_custo (integer) – ID do centro de custo.
Encomendar relatório¶
-
POSThttps://op.digesto.com.br/api/virtual_report/(id relatorio)/bill_start_update¶ Encomenda relatório. Esta operação consome créditos de uso da API. Após essa chamada, começaremos a atualizar os processos inseridos.
Esta ação é proibida para relatórios nos seguintes estados: - relatório já encomendado - relatório arquivado - quantidade máxima de relatórios de saneamento atingido
Nota
Requer módulo “(IP/API) Relatórios: relatório de saneamento por número”
Nota
Atenção: a cobrança é realizada por número CNJ atualizado por instância.
Caso selecione a busca em 1ª e 2ª instâncias o valor estimado para o relatório pode dobrar. Todavia, se houver:
- dificuldade técnica que impeça a atualização de algum processo, ou
- quantidade de processos em 2ª instância inferior ao dobro, o custo final será menor.
Exemplo de chamada sem centro de custo:
POST https://op.digesto.com.br/api/virtual_report/81801/bill_start_update HTTP/1.1 Content-Type: application/json
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json "Relatório encomendado com sucesso"
Parameters: - id – ID Digesto do relatório
Response JSON Object: - string – Mensagem de sucesso ou falha.
Exemplo de chamada com filtro de instância:
POST https://op.digesto.com.br/api/virtual_report/81801/bill_start_update HTTP/1.1 Content-Type: application/json {"instancias": [1,2]}
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json "Relatório encomendado com sucesso"
Parameters: - instancias – Lista com as instâncias de interesse. O default é que a busca aconteça na 1ª instância.
Response JSON Object: - string – Mensagem de sucesso ou falha.
Receber aviso de disponibilização de relatório prévio ou finalizado¶
Seguindo a API de eventos, enviamos um evento no endereço de webhook (HTTP POST) configurado para sua empresa, sinalizando que um relatório foi disponibilizado. O campo data do evento enviado contém o ID do relatório e um código de status.
Relatório prévio : evt_type = 15
Caso o relatório não seja finalizado em 24h, disponibilizamos uma prévia com as informações atualizadas até o momento e uma aba informando os processos que estão aguardando atualização no tribunal.
Relatório final : evt_type = 16
Exemplo relatório prévio:
{ 'status': 'preview', 'vr_id': 123 }Exemplo relatório finalizado:
{ 'status': 'finished', 'vr_id': 123 }
Obter dados consolidados de um relatório já encomendado¶
-
POSThttps://op.digesto.com.br/api/virtual_report/(relatorio_id)/final¶ Traz dados consolidados sobre os processos escolhidos para este relatório. É possível sofisticar o retorno dos processos do relatório aplicando filtros e ordenação. No exemplo abaixo, solicitamos o retorno de 20 processos por página, ordenados pela data de distribuíção.
Nota
Requer módulo “(IP/API) Relatórios: relatório de saneamento por número”
Exemplo de chamada:
POST https://op.digesto.com.br/api/virtual_report/1257/final HTTP/1.1 Content-Type: application/json { "filter":{ }, "sort":[ { "distribuicaoData":{ "order":"desc" } } ], "page":1, "itemsPerPage":20 }
:<json distribuicaoData : data de distribuição do processo
Exemplo de resposta:
Os processos do relatório se encontram na chave:
data->hits->hits, é a lista de processos atualizados do relatório. Cada item da lista vai ter uma chave_source, dentro dessa chave existe um objeto que representa os dados do processo.HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "billed_at": "Wed, 14 Dec 2022 15:15:51 GMT", "billing_code": "Centro de custo", "billing_code_id": 4926, "data": { "_shards": { "failed": 0, "skipped": 0, "successful": 1, "total": 1 }, "aggregations": { "agg_distrib": { "buckets": [ { "doc_count": 1, "key": 1483228800000, "key_as_string": "2017" } ] }, "agg_extinto": { "buckets": [ { "doc_count": 1, "key": 1 } ], "doc_count_error_upper_bound": 0, "sum_other_doc_count": 0 }, "agg_natureza": { "buckets": [ { "doc_count": 1, "key": "2" } ], "doc_count_error_upper_bound": 0, "sum_other_doc_count": 0 }, "agg_tribunais": { "buckets": [ { "doc_count": 1, "key": "TJRJ" } ], "doc_count_error_upper_bound": 0, "sum_other_doc_count": 0 }, "comarca-grid": { "buckets": [ { "doc_count": 1, "key": "72rd" } ] } }, "hits": { "hits": [ { "_id": "5-29200420178190209", "_index": "processo_vr_3195", "_score": null, "_source": { "acessos": "2022-10-11 03:09:47;2022-10-10 20:54:34;2020-09-30 22:13:11;2020-01-23 20:38:37", "alteradoEm": "2022-10-11T03:09:47", "anexos": [], "area": "C\u00edvel", "arquivado": false, "assuntoExtra": "Promessa de Compra e Venda / Coisas C/C,Perdas e Danos / Inadimplemento das Obriga\u00e7\u00f5es,Incorpora\u00e7\u00e3o Imobili\u00e1ria C/C,Cl\u00e1usula Penal / Inadimplemento C/C", "audiencias": [ { "datahora": "2017-04-12 ", "local": null, "tipo": "Sess\u00e3o de Media\u00e7\u00e3o" } ], "classeNatureza": "PROCEDIMENTO COMUM", "classeNatureza_dg": 2, "classes": [ "Promessa de Compra e Venda / Coisas C/C", "Perdas e Danos / Inadimplemento das Obriga\u00e7\u00f5es", "Incorpora\u00e7\u00e3o Imobili\u00e1ria C/C", "Cl\u00e1usula Penal / Inadimplemento C/C" ], "comarca": "REGIONAL DA BARRA DA TIJUCA", "comarca_cnj": "Rio de Janeiro", "comarca_geo": [ -22.9129, -43.2003 ], "criadoEm": "2020-01-23T20:37:51", "distribuicaoData": "2017-02-02", "distribuicaoTipo": "SORTEIO", "extinto": 1, "flag": 1, "fonte_sistema": "TJRJ", "foro": "REGIONAL DA BARRA DA TIJUCA", "foro_cnj": "Forum Regional da Barra da Tijuca", "gratuita": null, "instancia": 1, "juiz": null, "liminar": null, "natureza_id": 1, "num_anexos": 0, "num_partes": 8, "num_reus": 1, "numero": "0002920-04.2017.8.19.0209", "numeroAlternativo": "0002920-04.2017.8.19.0209 Procedimento Comum", "papel": "Advogado", "papel_id": 19, "partes": [ { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "GUILHERME VALDETARO MATHIAS", "parteID": 190884, "parteRelacaoID": 19, "processoParteAdvogadoID": 410794828, "relacaoNormalizado": "ADVOGADO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "FELIPE MARINO DAUDT", "parteID": 12159296, "parteRelacaoID": 19, "processoParteAdvogadoID": 410794837, "relacaoNormalizado": "ADVOGADO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "JO\u00c3O FELIPPE VARELLA RIBEIRO", "parteID": 18054176, "parteRelacaoID": 19, "processoParteAdvogadoID": 410794843, "relacaoNormalizado": "ADVOGADO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "GUILHERME DE CASTRO GOUVEA", "parteID": 13808965, "parteRelacaoID": 19, "processoParteAdvogadoID": 410794849, "relacaoNormalizado": "ADVOGADO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "FLAVIA MARIA FIGUEIREDO TEIXEIRA RIBEIRO", "parteID": 14575134, "parteRelacaoID": 19, "processoParteAdvogadoID": 410794855, "relacaoNormalizado": "ADVOGADO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": false, "is_re": true, "nomeParte": "BROOKSFIELD RIO DE JANEIRO EMPREENDIMENTOS IMOBILI\u00c1RIOS S/A", "parteID": 17789489, "parteRelacaoID": 35, "processoParteAdvogadoID": 410794858, "relacaoNormalizado": "REU" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": false, "is_coautora": false, "is_neutra": true, "is_re": false, "nomeParte": "LEONARDO MOUTINHO", "parteID": 17231403, "parteRelacaoID": 76, "processoParteAdvogadoID": 410794862, "relacaoNormalizado": "PERITO" }, { "advogados": [], "cnpj": null, "cpf": null, "documento": null, "is_autora": true, "is_coautora": false, "is_neutra": false, "is_re": false, "nomeParte": "WASHINGTON BARBEITO DE VASCONCELLOS", "parteID": 21849122, "parteRelacaoID": 34, "processoParteAdvogadoID": 410794866, "relacaoNormalizado": "AUTOR" } ], "processoID": 393505521, "processosRelacionados": [ { "codigo_identificador": "0002920-04.2017.8.19.0209 AGRAVO EM RECURSO ESPECIAL - C\u00cdVEL", "distribuicao_data": "2022-06-02", "id": 506214671, "instancia": 2, "natureza": "AGRAVO EM RECURSO ESPECIAL - CIVEL", "numero": "29200420178190209", "tribunal": "TJRJ" }, { "codigo_identificador": "0068816-39.2017.8.19.0000 AGRAVO DE INSTRUMENTO - C\u00cdVEL", "distribuicao_data": "2017-11-30", "id": 455310836, "instancia": 2, "natureza": "AGRAVO DE INSTRUMENTO - CIVEL", "numero": "688163920178190000", "tribunal": "TJRJ" }, { "codigo_identificador": "0002920-04.2017.8.19.0209 APELA\u00c7\u00c3O", "distribuicao_data": "2021-04-26", "id": 506214674, "instancia": 2, "natureza": "APELACAO", "numero": "29200420178190209", "tribunal": "TJRJ" }, { "codigo_identificador": "0002920-04.2017.8.19.0209 RECURSO ESPECIAL - C\u00cdVEL", "distribuicao_data": "2022-03-21", "id": 506214672, "instancia": 2, "natureza": "RECURSO ESPECIAL - CIVEL", "numero": "29200420178190209", "tribunal": "TJRJ" }, { "codigo_identificador": "AREsp 2178033 RJ", "distribuicao_data": "2022-07-29", "id": 496832966, "instancia": 3, "natureza": "AGRAVO EM RECURSO ESPECIAL", "numero": "29200420178190209", "tribunal": "STJ" } ], "regional_cnj": true, "segredo_justica": false, "sentencaData": "2021-01-22", "situacao": null, "situacao_situacaoID": null, "tipo_numero": 5, "tribunal": "TJRJ", "tribunalID": 55, "uf": "RJ", "valor": null, "vara": 7772, "vara_original": "1" }, "_type": "processo", "sort": [ 1485993600000 ] } ], "max_score": null, "total": 1 }, "timed_out": false, "took": 0 }, "eta": 2, "excel_completo": { "file_size": 27885, "s3_url": "<EXCEL URL>" }, "excel_simples": { "file_size": 27886, "s3_url": "<EXCEL URL>" }, "finished_at": "Wed, 14 Dec 2022 18:51:07 GMT", "invalid_cnjs": [], "name": "Relatório de Saneamento de Base (14/12/22)", "obs_processamento": null, "progress": 100, "tags": [] }
param relatorio_id: ID Digesto do relatório reqheader Authorization: token da API. Ver Autenticação. resheader Content-Type: application/json
Obter definição de um relatório de saneamento de base (/api/virtual_report)¶
-
GEThttps://op.digesto.com.br/api/virtual_report/(relatorio_id)¶ Traz dados cadastrais deste relatório já criado (não necessariamente já encomendado ou finalizado).
Os principais atributos de uma entidade
virtual_reportsão:- billed_at
- Se o relatório já foi encomendado.
- data
- Dados consolidados dos processos, agregados por data de distribuição, tribunal, natureza.
Exemplo de chamada:
GET https://op.digesto.com.br/api/virtual_report/1257 HTTP/1.1 Accept: application/json
Exemplo de resposta:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "$uri":"/api/virtual_report/1257", "archived_at":null, "billed_at":{ "$date":1671030951000 }, "billing_code_id":4926, "created_at":{ "$date":1671030937000 }, "data":{ "cnjs_distintos_atualizados":1, "excel":{ "simples":{ "file_size":17484, "s3_url":"https://storage.googleapis.com/proc-rpt-export/2023-02-11-3452-relatorio-de-saneamento-de-base-10-02-cdt-20230211-182415.xlsx" }, "completo":{ "file_size":17484, "s3_url":"https://storage.googleapis.com/proc-rpt-export/2023-02-11-3452-relatorio-de-saneamento-de-base-10-02-cdt-20230211-182419.xlsx" }, "simples_json":{ "file_size":2589, "s3_url":"https://storage.googleapis.com/proc-rpt-export/procs_relatorio-de-saneamento-de-base-10-02-23_Processos_2023-02-10-1832_rNz.json" }, "completo_json":{ "file_size":2589, "s3_url":"https://storage.googleapis.com/proc-rpt-export/procs_relatorio-de-saneamento-de-base-10-02-23_Processos_2023-02-10-1832_rNx.json" } }, "invalid_cnjs":[ ], "modelo":null, "valid_cnjs":[ "29200420178190209" ] }, "finished_at":{ "$date":1671043867000 }, "is_trial":false, "name":"Relatório de Saneamento de Base (14/12/22)", "proc_set_update_request_id":1, "user_company_id":1, "user_creator_id":1, "user_custom":null }
Parameters: - relatorio_id – ID Digesto do relatório
Response JSON Object: - archived_at (date) – data de arquivamento do relatório. Data em formato inteiro (JSON) (Formato de datas).
- billing_code_id (integer) – ID do centro de custo.
- created_at (date) – Data que o relatório foi criado. Data em formato inteiro (JSON) (Formato de datas).
- invalid_cnjs (list) – Lista com os cnjs inválidos inseridos no relatório.
- modelo (string) – modelo do relatório (padrão).
- valid_cnjs (list) – Lista com os cnjs válidos inseridos no relatório.
- finished_at (date) – data em que o relatorio foi finalizado. Data em formato inteiro (JSON) (Formato de datas).
- name (string) – nome do relatório de saneamento.
- proc_set_update_request_id (integer) – ID do pedido de atualização gerado para este relatório, esse ID é associado com o relatório quando ele é encomendado.
- user_company_id (integer) – ID da empresa.
- user_creator_id (integer) – ID do usuário que solicitou o relatório.
- user_custom (string) – valor livre para uso do sistema integrado à API. Usado para manter referências com identificadores externos. Valor é enviado no campo
source_user_customdos eventos de monitoramento que originarem deste recurso. Até 256 caracteres.