Pular para o conteúdo principal

Callback

A ferramenta de captura utiliza o mecanismo de callback para notificar automaticamente o sistema do cliente sempre que houver alteração no status de uma consulta.

No momento da criação de uma nova consulta, é possível informar uma URL válida e acessível para recebimento do retorno.

Sempre que o status da requisição for atualizado (por exemplo: success, warning ou error), a ferramenta enviará uma requisição HTTP para a URL informada.

Caso a URL esteja inválida, inexistente ou indisponível, novas tentativas de envio serão realizadas até o limite configurado. Após o número máximo de tentativas sem sucesso, o envio será interrompido.

Estrutura do Callback (Default)​

Estrutura padrão enviada sempre que o status da requisição é alterado:

{
  "action": "requestStatusChanged",
  "requestId": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
  "respondedAt": "2019-11-01T07:00:00.944Z",
  "status": "success"
}

Campos enviados:

  • action: Tipo do evento disparado
  • requestId: Identificador único da consulta
  • respondedAt: Data e hora da conclusão do processamento
  • status: Status atual da requisição

Estrutura do Callback (Full)​

Ao configurar o envio completo no momento da criação da nova consulta, a ferramenta retornará também todos os dados coletados.

{
  "action": "requestStatusChanged",
  "requestId": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
  "respondedAt": "2019-11-01T07:00:00.944Z",
  "status": "success",
  "type": "lawsuits",
  "requested": {
    "id": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
    "status": "success",
    "source": "courts",
    "platform": "esaj",
    "query": "principal",
    "court": "tjsp",
    "search": "tjsp",
    "param": {
      "key": "cnj",
      "value": "0002796-14.2013.8.26.0323"
    },
    "respondedAt": "2022-03-08T00:26:37.603Z",
    "createdAt": "2022-03-08T00:26:26.088Z"
  },
  "info": {
    "source": "Consulta de Processos",
    "platform": "eSAJ da Justiça Estadual",
    "search": "Tribunal de Justiça de São Paulo",
    "query": "Consulta de Processos de 1º Grau",
    "paramKey": "Numeração Única"
  },
  "data": [
    {
      "cover": [],
      "properties": {},
      "people": [],
      "steps": []
    }
  ]
}

Observações Importantes​

  • O envio ocorre sempre que houver mudança de status.
  • Recomenda-se que o endpoint do cliente:
    • Retorne status HTTP 200 para confirmar o recebimento.
    • Esteja preparado para receber múltiplas tentativas em caso de falha temporária.
  • O payload pode variar conforme a plataforma e os dados disponíveis no tribunal.

Caso não deseje utilizar callback, o resultado pode ser obtido manualmente: Visualizar por ID.

GET /v1/request/{requestId}