🏓 Ping

📋 Visão Geral

O Ping é o endpoint de verificação de disponibilidade da API Pública.

Ele permite confirmar que a API está ativa e acessível a partir do cliente que realiza a chamada, retornando uma resposta imediata e de baixo custo.

O uso mais comum é em healthchecks, monitoramentos automatizados e diagnósticos de conectividade, garantindo que integrações detectem falhas de disponibilidade antes de executar operações mais complexas.

🔄 Como Funciona

A rota não exige autenticação — qualquer cliente HTTP pode chamá-la sem fornecer token.

Se um token válido for enviado no cabeçalho Authorization, ele será processado normalmente pelo middleware PublicAuth, mas sua ausência não bloqueia nem altera a resposta.

A resposta é sempre "pong" quando a API está operacional, encapsulada no envelope padrão da plataforma.

📌 Notas e Considerações

• O endpoint não consome recursos de banco de dados — é uma resposta inline direta do servidor.
• Ideal para ser usado em sistemas de monitoramento de uptime, pipelines de CI/CD e healthchecks de infraestrutura.
• O tempo de resposta deste endpoint reflete exclusivamente a latência de rede e disponibilidade do servidor, sem overhead de processamento de negócio.

Ping

Descrição

Este endpoint realiza uma verificação simples de disponibilidade da API.

A chamada não requer nenhum parâmetro, corpo ou autenticação — basta enviar a requisição e aguardar o retorno "pong".

Autenticação opcional

O middleware PublicAuth processa o token caso ele seja enviado, mas não o exige.

Chamadas sem o cabeçalho Authorization são tratadas normalmente e recebem a mesma resposta de sucesso.

Resposta garantida

Enquanto a API estiver no ar, a resposta será sempre 200 OK com o payload "pong" — sem variações por contexto de loja, política comercial ou usuário.

Parâmetros

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/api/v3/ping \
3  --header 'User-Agent: insomnia/11.2.0'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "status": true,
5    "data": "pong"
6  }
7}