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"
}Premiers Pas & Configuration
Bilan de santé
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"
}Bilan de santé
Vérifiez si l’API est en cours d’exécution et saine. Aucune authentification requise.Point de terminaison
GET /health
Description
Ce point de terminaison vous permet de vérifier que l’API externe SecureAI est en cours d’exécution et saine. Aucune authentification n’est requise pour ce point de terminaison.Demande
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Réponse
Réponse réussie (200)
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}
Champs de réponse
| Champ | Tapez | Descriptif | Exemple |
|---|---|---|---|
success | booléen | Toujours vrai pour un bilan de santé réussi | true |
status | chaîne | État de santé de l’API | "healthy" |
timestamp | chaîne | Horodatage actuel du serveur au format ISO 8601 | "2024-01-15T10:30:00.000Z" |
version | chaîne | Version actuelle de l’API | "1.0.0" |
Exemple d’utilisation
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);
import requests
response = requests.get('https://{customer.name}.hiperai.ai/api/external/health')
data = response.json()
print('API Status:', data['status'])
boucle
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
Remarques
- Ce point de terminaison ne nécessite pas d’authentification
- Utilisez ce point de terminaison pour surveiller la disponibilité de l’API
- La réponse inclut la version actuelle de l’API pour la vérification de la compatibilité
Autorisations
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here