Rota de Monitoramento
Para começar a monitorar um processo, você deve realizar uma solicitação POST para a rota/tracking.
Payload da Solicitação
A solicitação POST deve incluir um payload com as seguintes propriedades:-
recurrence: A recorrência em dias de atualização dos processos. -
search: Objeto que vai para a busca.search_type: No contexto de monitoramento processual, o valor dsse campo sempre serálawsuit_cnj.search_key: O número do processo (Código CNJ), CPF, CNPJ, OAB ou NAME que você deseja buscar;
-
with_attachments(opcional): Esse campo define se você quer trazer anexos referente ao processo buscado podendo ser true ou falseObs:Os anexos só serão retornados caso o search_type for lawsuit_cnj.
-
search_params: Um objeto que contém alguns parâmetros da busca como:-
lawsuit_instance(opcional): Este parâmetro permite definir a instância em que deseja buscar o processo;*Obs: Caso o parâmetro lawsuit_instance não seja especificado, a busca retornará automaticamente a instância mais recente do processo. Por exemplo, se o processo estiver tramitando tanto na primeira quanto na segunda instância, a busca considerará a segunda instância, por ser a mais atualizada.
-
-
credential(opcional): Objeto para o uso do cofre de credenciais.customer_key(opcional): Permite passar a chave do usuário que você cadastrou no cofre de credenciais, não seja informado, a API tentará encontrar uma credencial cadastrada para acustomer_keyvazia.
-
notification_emails(opcional): Array de strings fora dosearchque podem ser adicionados emails para os quais deseja receber notificação a cada atualização do monitoramento cadastrado. -
step_terms: Esta propriedade é um array de strings que permite filtrar as movimentações processuais com base em termos específicos. Quando utilizada em conjunto com o monitoramento via webhook, o usuário receberá notificações apenas se algum dos termos especificados for encontrado em uma nova movimentação processual.
Na resposta da criação do monitoramento, é retornado o campo
hour_range, que indica o horário em que a consulta ao tribunal será realizada pela primeira vez. No exemplo acima, a primeira consulta está programada para ocorrer às 21 horas.O monitoramento irá ser iniciado a primeira vez, na melhor janela de
concorrência de requisição ao tribunal, dentro das próximas 24 horas
da data de criação.
Atualizando um Monitoramento
Para atualizar um monitoramento, você pode fazer uma solicitação PATCH para a rota/tracking/{monitoramento}, substituindo {monitoramento} pelo ID do monitoramento que você deseja atualizar.
Esta rota campos opcionais para atualização do tracking: recurrence, tags e o objeto de search para a busca com exceção de alguns campos.
Aqui está um exemplo de como fazer isso usando curl:
Consultando Seus Monitoramentos
Para consultar todos os seus monitoramentos, você pode fazer uma solicitação GET para a rota/tracking. Esta rota aceita alguns parâmetros de consulta opcionais para paginar e filtrar os resultados:
page: Define a página dos resultados que você deseja consultar.
page_size: Define o número máximo de resultados que você deseja receber por página;
search_type: retorna monitoramentos do tipo de referência especificado “cpf”, “cnpj”, “oab”, “lawsuit_cnj”, name ou rji;
search_key: retorna monitoramentos com a buscar relacionadas ao número do CPF, CNPJ, OAB ou processo informado;
status: retorna monitoramentos cujo status podem ser ‘created’, ‘updating’, ‘updated’, ‘paused’ ou ‘deleted’ ou mais de um de status [‘updating’, ‘paused’];
Aqui está um exemplo de como consultar seus monitoramentos usando curl:
Exemplo de notificação de webhook para monitoramento
Obs: Toda movimentação serão notificadas via webhook contendo o processo por completo, incrementando as últimas movimentações.Consultando histórico de um monitoramento
Para consultar o histórico de respostas geradas por um monitoramento específico, faça uma solicitação GET para a rota /tracking/, substituindo pelo ID do monitoramento desejado. Você pode filtrar os resultados usando os parâmetroscreated_at_gte e created_at_lte, onde:
created_at_gte: define a data inicial da consulta.
created_at_lte: define a data final da consulta.
Aqui está um exemplo de como fazer isso usando curl:
Pausando um Monitoramento
Para pausar um monitoramento, você pode fazer uma solicitação POST para a rota/tracking/{monitoramento}/pause, substituindo {monitoramento} pelo ID do monitoramento que você deseja pausar.
Aqui está um exemplo de como pausar o monitoramento usando o curl:
Reativando um Monitoramento
Para reativar um monitoramento pausado, você pode fazer uma solicitação POST para a rota/tracking/{monitoramento}/resume, substituindo {monitoramento} pelo ID do monitoramento que você deseja reativar.
Aqui está um exemplo de como reativar um monitoramento usando curl:
Deletando um Monitoramento
Para deletar um monitoramento, você pode fazer uma solicitação DELETE para a rota/tracking/{monitoramento}, substituindo {monitoramento} pelo ID do monitoramento que você deseja deletar.
Aqui está um exemplo de como deletar um monitoramento usando curl: