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"
}Primeros Pasos y Configuración
Health Check (Estado del 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"
}Control de salud
Compruebe si la API está funcionando y en buen estado. No se requiere autenticación.Endpoint
GET /health
Descripción
Este endpoint le permite verificar que la API externa SecureAI esté funcionando y en buen estado. No se requiere autenticación para este endpoint.Solicitud
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Respuesta
Respuesta exitosa (200)
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}
Campos de respuesta
| Campo | Tipo | Descripción | Ejemplo |
|---|---|---|---|
success | booleano | Siempre es cierto para un control de salud exitoso | true |
status | cadena | Estado de salud de la API | "healthy" |
timestamp | cadena | Marca de tiempo actual del servidor en formato ISO 8601 | "2024-01-15T10:30:00.000Z" |
version | cadena | Versión API actual | "1.0.0" |
Ejemplo de uso
JavaScript/Node.js
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/health');
const data = await response.json();
console.log('API Status:', data.status);
Pitón
import requests
response = requests.get('https://{customer.name}.hiperai.ai/api/external/health')
data = response.json()
print('API Status:', data['status'])
rizo
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Notas
- Este endpoint no requiere autenticación
- Utilice este endpoint para monitorear la disponibilidad de API
- La respuesta incluye la versión actual de la API para comprobar la compatibilidad.
Autorizaciones
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here