Diários Oficiais¶
A API para Diários Oficiais permite navegar e buscar entre as cópias de Diários Oficiais judiciais, executivos e administrativos de todo o país.
Cobertura¶
Confira a listagem completa e atualizada dos Diários Oficiais monitorados diariamente e disponíveis através desta API. Nossa cobertura de diários oficiais monitorados está em constante expansão.
Fontes de Diários Oficiais¶
Esta seção trata das requisições para obter detalhes sobre as fontes (diários) de documentos/páginas disponíveis no Radar Oficial.
Disponibilizamos uma listagem com o identificador interno usado para todos os cadernos e diários que fazem parte de nosso monitoramento e histórico de páginas. A listagem completa (com os identificadores) de cada fonte está disponível em formato JSON<https://op.digesto.com.br/api/diario/fontes_recortes> ou HTML.
Um mesmo diário oficial com frequência é dividido em diversos cadernos e nesta API cada caderno recebe um id diferente.
Este id é retornado como um atributo dos documentos e deve ser usado para filtrar buscas por determinados diários de seu interesse.
Listando as fontes de Diário Oficial¶
-
GET
https://op.digesto.com.br/api/diario/fontes_recortes
¶ Retorna a lista de diários oficiais para os quais há disponibilidade de recortes judiciais. Isto é, para estes diários o resultado do monitoramento contém campos estruturados como “processo”, “partes”, “seção”, “assunto normalizado” etc.
Chamada de exemplo:
GET https://op.digesto.com.br/api/diario/fontes_recortes HTTP/1.1
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json { "1": "TRF - 1ª Reg.", "18": "SP - TJ-cad.2-2ª Inst", "19": "SP - TJ-cad.3-1ª Inst-Cap.", "20": "SP - TJ-cad.4-1ª Inst-Int.-P.1", "21": "SP - TJ-cad.4-1ª Inst-Int.-P.2", "22": "SP - TJ-cad.4-1ª Inst-Int.-P.3", "23": "SP - TJ-cad.5-Editais e Leilões", "24": "SP - TJ-cad.1-Administrativo", "25": "Nacional - STF", "26": "Nacional - TST", "30": "AC - TRE", "31": "AL - TRE" }
-
GET
https://op.digesto.com.br/api/diario/fontes_termos
¶ Retorna a lista de diários oficiais para os quais há disponibilidade de monitoramento de termos quaisquer. Ou seja, para o monitoramento de nomes de produtos, serviços, licitações etc. Neste monitoramento não retornamos os dados em forma de recortes. O resultado consiste em um trecho de tamanho fixo do texto do diário próximo à menção do termo monitorado.
Chamada de exemplo:
GET https://op.digesto.com.br/api/diario/fontes_termos HTTP/1.1
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json { 1: "TRF - 1ª Reg.", 2: "Nacional - DOU - Seção 1", 3: "Nacional - DOU - Seção 2", 4: "Nacional - DOU - Seção 3", 5: "Nacional - DOU - Anvisa", 6: "SP - Cidade", 7: "SP - Empresarial", 8: "SP - Executivo - Cad. 1", 9: "SP - Executivo - Cad. 2", 10: "SP - Legislativo", 11: "SP - OAB", 12: "SP - JUCESP", 13: "MG - Executivo", 14: "MG - Justiça", 15: "MG - Terceiros", 16: "RS - Diário Oficial", 17: "RS - Industria e Comércio", 18: "SP - TJ-cad.2-2ª Inst", 19: "SP - TJ-cad.3-1ª Inst-Cap.", 20: "SP - TJ-cad.4-1ª Inst-Int.-P.1" }
Detalhes de uma fonte¶
-
GET
https://op.digesto.com.br/api/diario/source/
(int: id)¶ Os seguintes dados estão disponíveis para cada fonte retornada nesta chamada: [url externa, descricao, frequencia de atualizacao]
Chamada de exemplo:
GET https://op.digesto.com.br/api/diario/source/3 HTTP/1.1
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json [ "http://portal.in.gov.br/", "Publica todo e qualquer assunto de âmbito federal. A seção 2 trata de atos de interesse dos servidores da Administração Pública Federal.", 1 ]
Parameters: - id – identificador numérico do recurso
Detalhes de um resultado de publicações de termos gerais¶
Cada resultado é um objeto JSON, com os campos:
monitored_term
: (referencia) - referência ao termo monitorado.doc_id
: (integer) - identificador interno do documento de diário oficial onde houve a publicação. Para ser usado na API Diários Oficiais.snippet
: (string) - texto completo da página de diário oficial onde o termo monitorado foi encontrado. Ex.: “Duplicata - Adar Industria - Requerido para contestar..”. Enviado apenas nos resultados de diários judiciais, quando resultado se refere a um processo. Sempre é enviado.source id
: (number) - id da fonte (jornal/diário) que publicou este documento. A lista completa com descrição de cada fonte está disponível em Detalhes de uma fonte e para garantir um bom desempenho, os nomes das fontes associados a cada id de fonte deve ser cacheado do lado do cliente.published_at
: (date) - data oficial de publicação, usado para contagens de prazos etc. Data em formato inteiro (JSON) (Formato de datas).detected_at
: (date) - data em que o publicação foi obtida pela Digesto. Mesmo formado depublished_at
.docurl
: (string) - endereço original, nem sempre disponível pois algumas fontes não tem endereço fixo para suas páginas/cadernos de diários oficiais. Ex.: “http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2014/Fevereiro/04/jucesp/pdf/pg_0059.pdf”cached_docurl
: (string) - endereço de cópia para download de uma cópia do diário, hospedada pelo Digesto apenas por 30 dias. Disponibilizamos a URL de anexos para fins de transferencia dos dados para vocês apenas. Estas URLs não devem ser disponibiliadas para clientes finais. Usuários da API Digesto precisam fazer uma copia e hospedar para os clientes finais. Ex.: https://radaroficial_downloads.s3.amazonaws.com/321dff13fjkj13f
Buscar em Diários Oficiais¶
Retorna uma coleção de documentos, obtidos através de buscas textuais.
As buscas são realizadas sobre o corpo em texto puro e sem formatações das páginas dos diários oficiais. Este mesmo corpo em texto puro pode ser retornado na busca ou obtido através de requests para o resource Documento descrito abaixo.
A quebra das páginas das cópias de diários oficiais mantidas pelo Radar Oficial não obedecem exatamente o mesmo ponto de quebra de páginas dos diários originais, ou seja, não há uma associação exata entre documentos retornados pela busca e páginas dos Diários Oficiais. Uma página de um diário oficial original pode corresponder a mais de uma página (documento) dentro do motor de busca do Radar Oficial.
A especificação dos critérios da busca são passados no corpo do request HTTP e os servidores do Radar Oficial darão a resposta sincronamente (no mesmo request).
Em resumo as seguintes buscas são possíveis:
- buscas de termos isolados, frases ou expressões regulares
- operadores booleanos (AND, OR, exclusão de termos, combinações/expressões)
- filtros sobre os campos “Data de publicação” e “diário de origem”
- buscas aproximadas/fuzzy (algoritmo Levenshtein/edit distance)
Os resultados podem ser retornados com as seguintes funcionalidades:
- highlight configurável (tamanho, tag de highlight) com trechos do documento onde os termos de busca aparecem (snippets)
- faceting/sumarização dos campos “Data de publicação” e “diário de origem”
As buscas são expressas usando sintaxe compatível com a última versão do Elasticsearch. Assim são aceitas queries simples como term para recuperar documentos com determinadas propriedades ou - mais comumente - queries do tipo match para realizar buscas textuais.
É possível realizar buscas mais complexas (compostas) com operadores booleanos.
Queries também podem ter filtros para excluir documentos com determinados critérios, sem levar em conta o scoring. (apenas excluir documentos e não apenas alterar o score segundo critérios).
O exemplo de HTTP POST na documentação desta requisição (basta expandir detalhes clicando no título desta subseção) realiza uma busca de forma semelhante à busca histórica pública do Radar Oficial.
Veja a seguir outros exemplos de buscas.
Busca simples¶
-
POST
https://op.digesto.com.br/api/diario_doc/buscar
¶ Busca mais simples possível, com ordenação default (por relevância), trazendo os primeiros 2 resultados.
Exemplo de chamada:
POST https://op.digesto.com.br/api/diario_doc/buscar HTTP/1.1 Content-Type: application/json { "from": 0, "size": 2, "query": { "query_string": { "query": "\"b2w\"" } } }
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json { "took": 17, "timed_out": false, "_shards": { "total": 5, "successful": 5, "failed": 0 }, "hits": { "total": 4, "max_score": 0.6291202, "hits": [ { "_index": "doc", "_type": "doc", "_id": "6297021136764928", "_score": 0.6291202, "_source": { "body": "\nCOMERCIO DE SORVETES E MILK SHAKES LTDA - M.E. - ALTERACAO DO ENDERECO SEDE\nNIRE - 35227373081 - N. DA ALTERACAO: 369681/13-7 - N & T\nCOMERCIO DE SORVETES E MILK SHAKES LTDA - M.E. - ARQUIVAMENTO DE OUTROS.\nNIRE - 35227373081 - N. DA ... ALTERACAO: 393381/13-4 - TOTAL\nCOMERCIAL IMPORTADORA E EXPORTADORA LTDA - ALTERACAO DO ENDERECO SEDE\nNIRE - 35227518402 - N. DA ALTERACAO: 393381/13-4 - TOTAL\nCOMERCIAL IMPORTADORA E EXPORTADORA LTDA - ALTERACAO / INCLUSAO DE CGC 18.018.837/0001-23.", "source": "12", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2013/Outubro/22/jucesp/pdf/pg_0085.pdf", "publish_date": "2013-10-22T00:00:00" } }, { "_index": "doc", "_type": "doc", "_id": "5905226041131008", "_score": 0.5146002, "_source": { "body": "\n17.671.735/0001-40.\nNIRE - 35227339320 - N. DA ALTERACAO: 40496/14-4 - DROGARIA ISAMARY LTDA - M.E. - ALTERACAO DO ENDERECO\nSEDE\nNIRE - 35227339320 - N. DA ALTERACAO: 40496/14-4 - DROGARIA ISAMARY LTDA - M.E. - ARQUIVAMENTO DE OUTROS.\nNIRE - 35227339320 - N. DA ALTERACAO: 40496/14-4 - DROGARIA ISAMARY LTDA - M.E. - ALTERACAO / INCLUSAO DE CGC\n17.623.896/0001-68.\nNIRE ... 0001-69.\nNIRE - 35227657194 - N. DA ALTERACAO: 30111/14-6 - BARRETTO E BARRETTO INTERMEDIACOES LTDA - M.E. - ALTERACAO DO OBJETO SOCIAL PARA PREPARACAO DE DOCUMENTOS E SERVICOS ESPECIALIZADOS DE APOIO ADMINISTRATIVO\nNAO ESPECIFICADOS ANTERIORMENTE.\n\nA IMPRENSA OFICIAL DO ESTADO SA garante a autenticidade deste documento\nquando visualizado diretamente no portal www.imprensaoficial.com.br", "source": "12", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2014/Fevereiro/04/jucesp/pdf/pg_0059.pdf", "publish_date": "2014-02-04T00:00:00" } } ] } }
Request Headers: - Authorization – token da API. Ver Autenticação.
Response Headers: - Content-Type –
application/json
Paginação¶
Para trazer (quando houver) a segunda página dos resultados, basta alterar o campo from. O campo size representa o tamanho da página de resultados. A quantidade de resultados de uma busca pode ser consultada no campo [‘hits’][‘total’] de qualquer resposta.
Exemplo de chamada
POST https://op.digesto.com.br/api/diario_doc/buscar HTTP/1.1 Content-Type: application/json { "from": 24, "size": 24, "query": { "query_string": { "query": "\"digesto pesquisa\"" } } }
Filtrando por diários¶
Para trazer apenas resultados de alguns diários, é possível adicionar a cláusula filter conforme abaixo. Este exemplo realiza a busca apenas no diário MA - Terceiros.
Exemplo de chamada
POST https://op.digesto.com.br/api/diario_doc/buscar HTTP/1.1 Content-Type: application/json { "from": 0, "size": 2, "fields": [ "publish_date", "source", "docurl" ], "query": { "query_string": { "query": "demolicoes cadeado" } }, "filter": { "terms": { "source": [ 526 ] } } }
Response
HTTP/1.1 200 OK Content-Type: application/json { "took": 8, "timed_out": false, "_shards": { "total": 5, "successful": 5, "failed": 0 }, "hits": { "total": 63, "max_score": 0.40670916, "hits": [ { "_index": "doc", "_type": "doc", "_id": "6409940910473216", "_score": 0.40670916, "fields": { "source": "526", "publish_date": "2013-01-04T00:00:00", "docurl": "http://pesquisa.diariooficial.ma.gov.br/?d=TE20130104.pdf" } }, { "_index": "doc", "_type": "doc", "_id": "6718211852599296", "_score": 0.21594375, "fields": { "source": "526", "publish_date": "2010-03-05T00:00:00", "docurl": "http://pesquisa.diariooficial.ma.gov.br/?d=TE20100305.pdf" } } ] } }
Filtrando por datas¶
Para trazer apenas resultados em faixas de datas, é possível adicionar a cláusula filter conforme abaixo. Este exemplo traz resultados apenas dos meses 2012-Ago e 2013-Jul.
Exemplo de chamada
POST https://op.digesto.com.br/api/diario_doc/buscar HTTP/1.1 Content-Type: application/json { "from": 0, "size": 2, "fields": [ "publish_date", "source", "docurl" ], "query": { "query_string": { "query": "demolicao cadeado" } }, "filter": { "or": [ { "numeric_range": { "publish_date": { "lt": "2012-09-01", "gte": "2012-08-01" } } }, { "numeric_range": { "publish_date": { "lt": "2013-08-01", "gte": "2013-07-01" } } } ] } }
Exemplo de chamada
POST https://op.digesto.com.br/api/diario_doc/buscar HTTP/1.1 Content-Type: application/json { "from": 0, "size": 24, "fields": [ "publish_date", "source", "docurl" ], "query": { "query_string": { "query": "\"digesto pesquisa\"", "default_operator": "AND" } }, "facets": { "dates": { "date_histogram": { "field": "publish_date", "interval": "month" } }, "sources": { "terms": { "field": "source" } } }, "sort": { "publish_date": "desc" }, "highlight": { "number_of_fragments": 3, "fragment_size": 70, "order": "score", "require_field_match": "true", "fields": { "nome": {}, "resumo": {}, "texto": {}, "body": {}, "descricao": {}, "orgao": {} } } }
Exemplo de resposta
HTTP/1.1 200 OK Content-Type: application/json { "took": 1165, "timed_out": false, "_shards": { "total": 5, "successful": 5, "failed": 0 }, "hits": { "total": 4, "max_score": null, "hits": [ { "_index": "doc", "_type": "doc", "_id": "5905226041131008", "_score": null, "fields": { "source": "12", "publish_date": "2014-02-04T00:00:00", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2014/Fevereiro/04/jucesp/pdf/pg_0059.pdf" }, "sort": [ 1391472000000 ] }, { "_index": "doc", "_type": "doc", "_id": "6297021136764928", "_score": null, "fields": { "source": "12", "publish_date": "2013-10-22T00:00:00", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2013/Outubro/22/jucesp/pdf/pg_0085.pdf" }, "sort": [ 1382400000000 ] }, { "_index": "doc", "_type": "doc", "_id": "30946010", "_score": null, "fields": { "source": 12, "publish_date": "2013-04-09T00:00:00", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2013/Abril/09/jucesp/pdf/pg_0086.pdf" }, "sort": [ 1365465600000 ] }, { "_index": "doc", "_type": "doc", "_id": "30871431", "_score": null, "fields": { "source": 12, "publish_date": "2013-04-09T00:00:00", "docurl": "http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2013/Abril/09/jucesp/pdf/pg_0139.pdf" }, "sort": [ 1365465600000 ] } ] }, "facets": { "dates": { "_type": "date_histogram", "entries": [ { "time": 1364774400000, "count": 2 }, { "time": 1380585600000, "count": 1 }, { "time": 1391212800000, "count": 1 } ] }, "sources": { "_type": "terms", "missing": 0, "total": 4, "other": 0, "terms": [ { "term": "12", "count": 4 } ] } } }
Detalhes de um Documento de Diário Oficial¶
-
GET
https://op.digesto.com.br/api/diario_doc/get/
(int: id)¶ Representa um único documento, ou seja, uma página de um diário oficial conforme salva na base do Radar Oficial.
Os seguintes dados estão disponíveis para cada documento retornado nesta chamada e nas buscas textuais: id, corpo da página, url original, data de publicação, id do diário oficial de origem.
- Attributes (object)
- id (number): 5905226041131008 - id numérico que identifica unicamente o documento.
- source (number): 12 - id da fonte (jornal/diário) que publicou este documento.
- publish_date (string): data de publicação. Ex.: “2015-03-13T11:48:34”
- docurl (string): endereço original. Ex.: “http://diariooficial.imprensaoficial.com.br/doflash/prototipo/2014/Fevereiro/04/jucesp/pdf/pg_0059.pdf”
- cached_docurl (string): endereço de cópia para download. Ex.: https://radaroficial_downloads.s3.amazonaws.com/321dff13fjkj13f
- prev_page (number): página anterior. Ex.: 5905226041131007
- next_page (number): página posterior. Ex.: 5905226041131009
- body (string): texto puro completo. Ex.: COMERCIO DE SORVETES E MILK SHAKES LTDA - M.E. - ALTERACAO…
Chamada de exemplo:
GET https://op.digesto.com.br/api/diario_doc/get/12312343 HTTP/1.1
Exemplo de resposta:
HTTP/1.1 200 OK Content-Type: application/json { "_type": "doc", "_source": { "body": "O:\nR$644.164,28 (seiscentos e quarenta e quatro mil, cento e sessenta e quatro\nreais e vinte oito centavos), que corresponde a um percentual de 9,925%\n(nove virgula novecentos e vinte e cinco por cento) do valor", "next_page_id": "12312344", "source": 123, "docurl": "http://imagens.seplag.ce.gov.br/pdf/20121003/do20121003p01.pdf", "publish_date": "2012-10-03", "prev_page_id": "12308558", "id": 12312343 }, "_index": "doc", "_version": 1, "found": true, "_id": "12312343" }
Parameters: - id – identificador numérico do documento no índice Digesto de páginas de diários oficiais.