Baixar Collection

Monitoramento De Processos - Escavador API - Documentação

Grupo

Monitoramento de processos

Criar um monitoramento

POST /api/v2/monitoramentos/processos
Requer autenticaçãoGrátis

O número do processo informado será monitorado nos tribunais e diários oficiais. Todas as movimentações e publicações encontradas serão enviadas. Ao criar um monitoramento, ele começará com o status PENDENTE e será alterado para ENCONTRADO assim que nosso robô localizar o processo no sistema do tribunal. Se o processo não for encontrado, o status será atualizado para NAO_ENCONTRADO e não haverá cobrança.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: POST.

Callbacks relacionados

Evento Descrição
nova_movimentacao Ocorre quando um monitoramento de processo encontra uma nova movimentação no tribunal ou diário oficial.
processo_verificado Ocorre quando um monitoramento de processo vai ao tribunal, mas não encontra uma nova movimentação.
processo_encontrado É enviado assim que nosso robô localiza o processo no sistema do tribunal e o status do monitoramento é alterado para ENCONTRADO.
processo_nao_encontrado Ocorre quando o processo não é encontrado no sistema do tribunal e o status do monitoramento é alterado para NAO_ENCONTRADO.

Body Parameters

?
numero string Obrigatório

Númeração CNJ do processo.

tribunal string Opcional

Sigla do tribunal a ser monitorado. Caso não deseje acompanhar o processo no tribunal de origem, como em situações em que o processo está no STF com a mesma numeração.

frequencia string Opcional

Quantidade de dias em que o robô buscará atualizações nos sistemas dos tribunais.
Valores permitidos:
DIARIA: De segunda a sexta.
SEMANAL: 1 vez na semana (O dia é escolhido pelo Escavador).
Default: DIARIA.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 17,
    "numero": "0000001-00.2024.6.14.0000",
    "criado_em": "2024-11-19T20:35:09+00:00",
    "data_ultima_verificacao": null,
    "tribunais": [
        {
            "id": 50,
            "nome": "Tribunal Regional Eleitoral do Pará",
            "sigla": "TRE-PA",
            "categoria": null
        }
    ],
    "frequencia": "DIARIA",
    "status": "PENDENTE"
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}

Listar os monitoramentos

GET /api/v2/monitoramentos/processos
Requer autenticaçãoGrátis

Retorna todos os monitoramentos de processos do usuário

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "items": [
        {
            "id": 1566931,
            "numero": "0800493-92.2024.8.14.0112",
            "criado_em": "2024-10-02T16:15:45+00:00",
            "data_ultima_verificacao": null,
            "tribunais": [
                {
                    "id": 90,
                    "nome": "Tribunal de Justiça do Pará",
                    "sigla": "TJPA",
                    "categoria": null
                }
            ],
            "frequencia": "DIARIA",
            "status": "ENCONTRADO"
        },
        {
            "id": 1567024,
            "numero": "1002089-72.2023.8.26.0260",
            "criado_em": "2024-10-02T18:01:34+00:00",
            "data_ultima_verificacao": null,
            "tribunais": [
                {
                    "id": 102,
                    "nome": "Tribunal de Justiça de São Paulo",
                    "sigla": "TJSP",
                    "categoria": null
                }
            ],
            "frequencia": "DIARIA",
            "status": "ENCONTRADO"
        },
        {
            "id": 1567034,
            "numero": "1157146-44.2024.8.26.0100",
            "criado_em": "2024-10-02T18:15:48+00:00",
            "data_ultima_verificacao": null,
            "tribunais": [
                {
                    "id": 102,
                    "nome": "Tribunal de Justiça de São Paulo",
                    "sigla": "TJSP",
                    "categoria": null
                }
            ],
            "frequencia": "DIARIA",
            "status": "ENCONTRADO"
        }
    ],
    "links": {
        "next": null,
        "prev": null,
        "first": "https://api.escavador.com/api/v2/monitoramentos/processos?page=1",
        "last": "https://api.escavador.com/api/v2/monitoramentos/processos?page=1"
    },
    "paginator": {
        "current_page": 1,
        "per_page": 20,
        "total": 3,
        "total_pages": 1
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}

Buscar um monitoramento

GET /api/v2/monitoramentos/processos/{id}
Requer autenticaçãoGrátis

Retorna um monitoramento de processos a partir do id

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 17,
    "numero": "0000001-00.2024.6.14.0000",
    "criado_em": "2024-11-19T20:35:09+00:00",
    "data_ultima_verificacao": null,
    "tribunais": [
        {
            "id": 50,
            "nome": "Tribunal Regional Eleitoral do Pará",
            "sigla": "TRE-PA",
            "categoria": null
        }
    ],
    "frequencia": "DIARIA",
    "status": "PENDENTE"
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Remover um monitoramento

DELETE /api/v2/monitoramentos/processos/{id}
Requer autenticaçãoGrátis

Remove um monitoramento de processos a partir do id

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: DELETE.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Exemplos de respostas válidas

HTTP 204 ? 
[]
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}