Documentação da API do Digesto Operações¶
A Application Programming Interface (API) do Digesto Operações disponibiliza a desenvolvedores terceiros as funcionalidades de apoio a operações jurídicas existentes no portal.
Conteúdo
- Introdução
- Como funciona?
- Como contratar?
- Comunicação sobre mudanças e status do serviço
- Formato e URL base para requisições
- Métodos HTTP
- Respostas HTTP
- Recursos da API
- Detalhes de um evento (
/api/monitored_event) - Detalhes de uma pessoa monitorada (
/api/monitored_person) - Detalhes de uma expressão monitorada (
/api/monitored_term) - Detalhes de um processo monitorado (
/api/proc) - Detalhes de um conjunto de processos monitorados (
/api/proc_set) - Detalhes de uma reclamação Procon
- Detalhes de um perfil de fornecedor no Procon (
/api/procon_fornecedor) - Detalhes de um usuário (
/api/user) - Detalhes de uma empresa (
/api/user_company)
- Detalhes de um evento (
- Criando recursos
- Listando recursos
- Modificando recursos
- Excluindo recursos
- Tags de recursos
- Histórico de modificações de recursos
- Documentos e anexos retornados pela API
- Formato de datas
- Versionamento da API
- Limites e restrições
- Linguagens de programação
- Autenticação
- Rotas da API
- Base judicial
- Obtendo detalhes de processo judicial
- Detalhes de um processo judicial (
/api/tribproc) - Detalhes de publicações judiciais
- Instâncias de processos suportadas
- Valores atuais para o campo periodico_orgao_slug
- Atualizando dados de processos no tribunal por demanda
- Critérios para disponibilização de anexos de processos
- Extrair números de processos válidos (CNJ) de um texto
- Verificar se processo é digital (
/api/tribproc/is_digital/<cnj>) - Naturezas processuais padrão Digesto
- Background check
- Background check avançado
- Monitoramento
- Tipos
- Cobertura
- Frequência de monitoramento
- Frequência de envio de resultados via email
- Frequência de envio de resultados via webhook
- Falhas ao fazer envio dos resultados via webhook
- Registrando partes para monitoramento
- Detalhes de uma pessoa monitorada (
/api/monitored_person) - Registrando processos para monitoramento
- Detalhes de um processo monitorado (
/api/proc) - Detalhes de um conjunto de processos monitorados (
/api/proc_set) - Monitoramento de processos em 2ª instância
- Listando processos monitorados
- Tipos de números de processos
- Registrando palavras para monitoramento em Diários Oficiais
- Detalhes de uma expressão monitorada (
/api/monitored_term) - Listar todas os IDs de partes ou expressões regulares de uma empresa
- Solicitar renovação da validade de URLs de anexos
- Obter variações de nomes para parte monitorada
- Obter variações de nomes para parte monitorada na base 2
- Eventos
- Dados de um evento
- Exemplo de retorno webhook com eventos descrevendo novos processos distribuídos
- Exemplo de retorno webhook com evento descrevendo que um processo judicial foi atualizado
- Exemplo de retorno webhook com eventos de publicações de processos e partes
- Exemplo de retorno webhook com eventos de movimentações em processos
- Exemplo de retorno webhook com eventos de publicações de termos em diários oficiais
- Listando eventos
- Listando chamadas webhook
- Descrição de eventos de problemas em monitoramentos
- Descrição de mudanças nos atributos de processos
- Diários Oficiais
- Relatórios due diligence
- Prazos para conclusão dos relatórios
- Criar um relatório
- Obter dados prévios consolidados de um relatório
- Atualizar relatório
- Encomendar relatório
- Receber aviso de que relatório foi finalizado ou suspenso
- Obter dados consolidados de um relatório já encomendado
- Obter definição de um relatório due diligence (
/api/live_report_def) - Exportar dados dos processos de um relatório due diligence
- Clonar um relatório due diligence
- Saneamento de base
- Prazos para conclusão dos relatórios
- Criar um relatório
- Obter dados prévios consolidados de um relatório
- Associando um relatório com um centro de custo
- Encomendar relatório
- Receber aviso de disponibilização de relatório prévio ou finalizado
- Obter dados consolidados de um relatório já encomendado
- Obter definição de um relatório de saneamento de base (
/api/virtual_report)
- Análise de risco judicial
- Usuários na API
- Empresas na API
- Procon
- Dúvidas frequentes
- Chamadas API
- Porque recebo resposta HTTP 400 e mensagem “None is not of type ‘object’”?
- Posso fazer chamadas à API para ler as novidades no monitoramento?
- A API envia os eventos para um unico webhook ou eu posso cadastrar varios webhooks para receber cada tipo de evento?
- A API aceita chamadas HTTP (porta 80)?
- Erro de certificado HTTPS “unable to find valid certification path to requested target” com cliente Java
- Não estou recebendo as chamadas em meu sistema com os eventos de monitoramento
- Como saber quais chamadas de callback (webhook) falharam definitivamente?
- Como validar o token de acesso à API?
- Como saber de qual empresa é um evento, quando recebo eventos de várias empresas no mesmo endereço HTTP de retorno?
- Não recebi eventos de monitoramento pois todas as 13 tentativas falharam. Como faço para receber?
- Monitoramento
- Ao reativar parte monitorada, enviamos resultados retroativos?
- Quando faço ajustes à expressão de busca de uma parte monitorada, resultados retroativos são enviados?
- É possível monitorar nomes de partes pelo CNPJ ou CPF e evitar resultados de processos de homônimos?
- Um mesmo processo ou nome pode ser cadastrado duas vezes se estiverem em empresas diferentes?
- Como verifico se um evento de monitoramento envolvendo processos foram gerados?
- As primeiras distribuições de uma nova parte monitorada não estão vindo com anexos
- É possível usar o modulo de monitoramento de distribuição para pegar processos mais antigos de uma parte monitorada?
- Qual a lógica de descoberta de novos processos usada no sistema do tribunal?
- Atraso na captura das distribuições de processos
- Atraso na captura e envio de publicações
- Há variação no prazo de captura de processos após distribuição entre os tribunais?
- Porque há uma redução na quantidade de processos distribuídos na segunda-feira?
- Quanto tempo demora para baixar os autos de um processo?
- Quanto tempo demora em média para atualizar os dados de processos no tribunal por demanda?
- Como monitorar processos por citação?
- Precisamos monitorar pessoas físicas e cadastramos essas pessoas como partes monitoradas com Nome + CPF, mas o CPF não está sendo validado (trazendo falsos positivos)
- Quando recebemos uma distribuição, geralmente temos o CPF da contraparte. Pelo que entendi, o CPF, é obtido no anexo. Assim, se não conseguiram pegar o anexo, não conseguiram pegar o CPF da parte também?
- Porque nem todas as audiências são enviadas junto dos dados da distribuição de novo processo?
- Porque as distribuições de alguns estados não estão vindo com o valor de causa?
- Porque estou recebendo poucas distribuições quando comparado com os processos obtidos durante o mesmo periodo por via tradicional?
- Por que não reportarmos distribuições em segredo de justiça?
- A atualização da captura das distribuições ocorre em determinado horário do dia?
- Porque o layout dos anexos parece estranho e/ou sem formatação?
- Como remover o monitoramento de um processo?
- É possível monitor publicações de um advogado mas só as envolvendo uma empresa?
- É possível filtrar o monitoramento pelo estado ou tribunal?
- Não recebi um processo via monitoramento de distribuições
- Porque a ditribuição veio sem anexos?
- Ao cadastrar uma pessoa, a busca é feita apenas pelo nome?
- Devem ser cadastradas variações fonéticas? Se sim, como?
- A OAB é utilizada na busca? Qual formato ela deve ser cadastrada?
- É possível passar uma OAB + data e a API trazer todas as movimentações e publicações até a data informada?
- Quando a distribuição for encontrada pelo CPF, vem algo dizendo isso?
- Ao cadastrar o regex (para variações fonéticas) devemos adicionar nele a OAB ou as buscas são feitas de forma independente?
- Em qual evento ou lugar podemos pesquisar para trazer as audiências, e caso necessário, atualizações dos dados das audiências?
- Como monitorar palavras quaisquer em diários, mas com o resultado vindo estruturado como recorte?
- O que acontece caso o processo tenha sido cadastrado com número errado?
- Qual a relação entre empresas, pastas e processos?
- Usuários e Empresas
- Volume de uso e Cobrança da API
- Dados da base judicial
- Cobertura
- Chamadas API
- Histórico de mudanças
- Service level agreement