Documentação Técnica

Health Check - Empresas

Essa chamada possibilita a verificação de status da API de Pessoas, verificando se a API está funcional ou se apresenta algum problema, verificando, também, o tempo de resposta médio das chamadas realizadas nos últimos 5 minutos. Ela pode ser integrada com sistemas de alarme e monitoramento, simplificando o processo de acompanhamento de status da API. Tanto a chamada quanto o retorno são estruturados da mesma forma que a chamada para os datasets convencionais, fazendo com que a integração dessa chamada seja simples e rápida.

Todas as chamadas de Health Check são _logadas _da mesma forma que chamadas convencionais, e retornam um query id que pode ser utilizado para recuperar o seu resultado através da API de Eventos.

Descrição dos campos

CampoRetorno
StatusIndicador de status da API. "OK" significa que não existem problemas, qualquer outro status indica problemas operacionais.
ResponseAvgTimeTempo médio de resposta, em milissegundos, das chamadas realizadas pelo cliente nos últimos 5 minutos.
Language
Authorization
Click Try It! to start a request and see the response here!