Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}Primeiros Passos & Configuração
Health Check (Status do Sistema)
Check if the API is running and healthy. No authentication required.
GET
/
health
Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}Exame de saúde
Verifique se a API está funcionando e íntegra. Nenhuma autenticação necessária.Ponto final
GET /health
Descrição
Este endpoint permite verificar se a API externa SecureAI está em execução e íntegra. Nenhuma autenticação é necessária para este endpoint.Solicitação
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Resposta
Resposta de sucesso (200)
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}
Campos de resposta
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
success | booleano | Sempre verdadeiro para uma verificação de saúde bem-sucedida | true |
status | corda | Estado de saúde da API | "healthy" |
timestamp | corda | Carimbo de data/hora atual do servidor no formato ISO 8601 | "2024-01-15T10:30:00.000Z" |
version | corda | Versão atual da API | "1.0.0" |
Exemplo de uso
###JavaScript/Node.jsconst response = await fetch('https://{customer.name}.hiperai.ai/api/external/health');
const data = await response.json();
console.log('API Status:', data.status);
import requests
response = requests.get('https://{customer.name}.hiperai.ai/api/external/health')
data = response.json()
print('API Status:', data['status'])
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Notas
- Este endpoint não requer autenticação
- Use este endpoint para monitorar a disponibilidade da API
- A resposta inclui a versão atual da API para verificação de compatibilidade
Autorizações
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here