Baixar Collection

Monitoramento No Site Do Tribunal - Escavador API - Documentação

Grupo

Monitoramento no site do Tribunal

Retornar monitoramentos

GET /api/v1/monitoramentos-tribunal
Requer autenticaçãoGrátis

Retorna todos os monitoramentos criados pelo usuário.

Visão geral

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

Exemplos de respostas válidas

HTTP 200 ? 
{
    "items": [
        {
            "id": 1,
            "origem": "TJDF",
            "tipo": "UNICO",
            "valor": "0000000-00.0000.0.00.0000",
            "cron": "4 4 * * 1-5",
            "status": "ENCONTRADO",
            "frequencia": "DIARIA",
            "desativado": false
        },
        {
            "id": 2,
            "origem": "TRT-2",
            "tipo": "UNICO",
            "valor": "0000000-00.0000.0.00.0000",
            "cron": "5 5 * * 1-5",
            "status": "ENCONTRADO",
            "frequencia": "DIARIA",
            "desativado": false
        },
        {
            "id": 3,
            "origem": "TRT-2",
            "tipo": "UNICO",
            "valor": "0000000-00.0000.0.00.0000",
            "cron": "6 6 * * 1-5",
            "status": "ENCONTRADO",
            "frequencia": "DIARIA",
            "desativado": false
        }
    ],
    "links": {
        "first": "http://api.escavador.com/api/v1/monitoramentos-tribunal?page=1",
        "last": "http://api.escavador.com/api/v1/monitoramentos-tribunal?page=1",
        "prev": null,
        "next": null
    },
    "paginator": {
        "current_page": 1,
        "per_page": 20,
        "total": 3,
        "total_pages": 1
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Retornar monitoramento

GET /api/v1/monitoramentos-tribunal/{monitoramentoId}
Requer autenticaçãoGrátis

Retorna um monitoramento pelo identificador.

Visão geral

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

URL Parameters

?
monitoramentoId integer Obrigatório

Identificador numérico do monitoramento.

Exemplos de respostas válidas

HTTP 200 ? 
{
    "id": 1,
    "origem": "TJDF",
    "tipo": "UNICO",
    "valor": "0000000-00.0000.0.00.0000",
    "cron": "4 4 * * 1-5",
    "status": "ENCONTRADO",
    "frequencia": "DIARIA",
    "desativado": false
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Editar um monitoramento

PUT /api/v1/monitoramentos-tribunal/{monitoramentoId}
Requer autenticaçãoGrátis

Edita um monitoramento de sistema do tribunal. É possível alterar apenas a frequência do monitoramento.

{ "status": "success" }

Visão geral

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

URL Parameters

?
monitoramentoId string Obrigatório

Sem descrição

Body Parameters

?
frequencia string Opcional

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

Exemplos de respostas válidas

HTTP 200 ? 
{
    "status": "success"
}

Remover monitoramento

DELETE /api/v1/monitoramentos-tribunal/{id}
Requer autenticaçãoGrátis

Remove um monitoramento pelo identificador cadastrado pelo usuário.

Visão geral

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

URL Parameters

?
id integer Obrigatório

Identificador numérico do monitoramento.

Exemplos de respostas válidas

HTTP 200 ? 
{
    "id": 1,
    "monitor": {
        "origem": "TJSP",
        "tipo": "UNICO",
        "valor": "0000000-00.0000.0.00.0000"
    },
    "deleted_at": "0000-00-00 00:00:00"
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Registrar novo monitoramento

POST /api/v1/monitoramentos-tribunal
Requer autenticaçãoGrátis

Cadastra o número de um processo para ser monitorado nos tribunais. Ao encontrar algo novo, um callback é enviado para a sua url definida. Você pode consultar todos os callbacks enviados e os status.

Visão geral

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

Callbacks relacionados

Evento Descrição
update_status Quando um Monitoramento do site do Tribunal é criado para o tipo UNICO (numeração CNJ do Processo), o Escavador vai procurar pela existência daquele processo nos sistemas dos Tribunais e informar se encontrou ou não o processo.
movimentacao_nova Foi encontrado um novo andamento no Processo no Sistema do Tribunal. Apenas para monitoramento do tipo UNICO (numeração CNJ do Processo).
processo_dado_novo Foi encontrada uma nova informação nova na capa do processo. Apenas para monitoramento do tipo UNICO (numeração CNJ do Processo).
envolvido_novo Foi encontrado um novo envolvido no processo. Apenas para monitoramento do tipo UNICO (numeração CNJ do Processo).
novo_processo_envolvido Foi encontrado um novo processo para o monitoramento de nome ou documento. Apenas para monitoramentos do tipo NUMDOC ou NOME.

Body Parameters

?
tipo string Obrigatório

O tipo do valor a ser monitorado.
Valores permitidos:
UNICO:Numeração CNJ do processo. O monitoramento vai procurar por andamentos novos.
NUMDOC: CPF, CNPJ ou OAB. O monitoramento vai procurar processos novos relacionados a esse documento.
NOME: Nome do envolvido no processo. O monitoramento vai procurar processos novos relacionados a esse nome
ALTERNATIVO: Numeração alternativa do processo para o STF ou STJ.

estado_oab string Opcional

Estado da OAB. Se o valor enviado é um número de oab, é necessário informar o estado (UF) da oab na requisição

valor string Obrigatório

O número de processo, nome ou documento a ser monitorado.

tribunal string Obrigatório

Tribunal a ser pesquisado, opcional para tipo=UNICO. Passar outro tribunal para o tipo=UNICO, vai forçar o monitoramento no tribunal informado. Consulte os Tribunais disponíveis.

frequencia string Opcional

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

tipo_numero string Opcional

Se tribunal == STF é possivel enviar o número de processo no formato de classe e número (Ex: HC 211509) passando tipo_numero == "classe_numero".
Se tribunal == STJ é possível enviar o número de processo no formato de número de registro (Ex: 2021/0179885-9) passando tipo_numero == "numero_registro".

Exemplos de respostas válidas

HTTP 200 ? 
{
    "id": 1,
    "vip": true,
    "monitor": {
        "origens": [
            "TRT-5"
        ],
        "tipo": "UNICO",
        "valor": "0000000-00.0000.0.00.0000",
        "frequencia": "DIARIO",
        "cron": "45 21 * * 1-5",
        "status": "FOUND",
        "incluir_docpub": false,
        "incluir_autos": false
    },
    "created_at": "15/08/2022 16:21:29",
    "frequencia": "DIARIA"
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}