🩺 APIs de Health Check

Além das consultas aos datasets já descritos, as APIs de Pessoas e de Empresas disponibilizam também uma consulta de Health Check, ou seja, de verificação do status do serviço.
O objetivo dessa consulta é permitir que qualquer usuário verifique o status das APIs sem custo e sem precisar construir o seu próprio sistema de monitoramento de retornos.

Essa chamada retorna, além de um status geral do sistema, o tempo de resposta médio das requisições feitas pelo cliente que está realizando a chamada, calculado em cima dos últimos 5 minutos de operação do mesmo. O health check de pessoas e de empresas é idêntico, alterando apenas o endpoint que deve ser acionado em cada um dos casos.

Importante: As chamadas de Health Check nunca implicam em nenhum custo ou cobrança para o usuário.

Para saber mais sobre as diferentes operações disponíveis na API de Health Check, acesse a documentação técnica.