Monitoramento de Documento
Essa página tem como objetivo mostrar o fluxo de Monitoramento de Documento.
Criação do monitoramento
curl --request POST
--url "https://tracking.prod.judit.io/tracking"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"
--data "{
'search': {
'search_type': 'cpf',
'search_key': '092.065.297-22'
}
}"
Retorno:
{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "created",
"recurrence": 1,
"search": {
"search_type": "cpf",
"search_key": "092.065.297-22",
"response_type": "lawsuits",
"search_params": {
"filter": {},
"pagination": {}
}
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}
O monitoramento irá ser iniciado a primeira vez, na melhor janela de concorrência de requisição ao tribunal, dentro das próximas 5 horas da data de criação.
Depois ocorrerá todos os dias úteis no mesmo horário.
Outros parâmetros que podem ser adicionados na requisição, como filtros, podem ser encontrados na página:
https://docs.judit.io/api-reference/endpoint/tracking/create
Consultar o status do monitoramento
Na URL vai o tracking_id retornado na primeira requisição:
curl --request GET
--url "https://tracking.prod.judit.io/tracking/15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"
Retorno:
{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "created",
"recurrence": 1,
"search": {
"search_type": "cpf",
"search_key": "092.065.297-22",
"response_type": "lawsuits",
"search_params": {
"filter": {},
"pagination": {}
}
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {
"dashboard_id": null
},
"request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}
A propriedade status informa a situação atual do monitoramento, podendo ser:
created: Monitoramento criado, porém nunca executado.
updating: Está com uma requisição em processamento.
updated: Monitoramento atualizado já com alguma resposta disponível. O campo updated_at pode informar a data de última atualização do monitoramento e a propriedade request_id o id da última request feita pelo monitoramento.
paused: Monitoramento pausado, podendo ainda ser reativado.
deleted: Monitoramento cancelado e não pode mais ser reativado.
A propriedade request_id só é criada a partir da primeira vez que o monitoramento executou, ou seja, chegou ao status updated.
Consultar o conteúdo da resposta (nova ação encontrada)
Na URL vai o request_id retornado na primeira requisição:
curl --request GET
--url "https://requests.prod.judit.io/responses/?request_id=15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"
O parâmetro page e page_size são opcionais, porém necessários para percorrer as páginas com os processos, caso venham mais de uma, o que é comum no caso de consulta por documento.
Define a página atual da busca.
Total de processos na página.
Total de processos encontrados
Quantidade de páginas de processos
Array com as respostas e dentro da propriedade response_data o conteúdo do processo.
No caso de monitoramento de documento, ele sempre será de novas ações, ou seja, as requisições só gerarão respostas caso um novo processo seja distribuído.
O significado de cada campo pode ser encontrado no glossário: