État de santé de l'API
Vérifiez le statut de l'API et la disponibilité des services externes (BCE/KBO Public Search). Cet endpoint ne nécessite pas d'authentification et peut être utilisé pour le monitoring.
GET
/api/healthExemple de requête
cURL
curl -X GET "https://companybelgium.be/api/health"
JavaScript / Node.js
const response = await fetch('https://companybelgium.be/api/health');
const data = await response.json();
console.log(`API Status: ${data.status}`);
console.log(`Version: ${data.version}`);
console.log(`Uptime: ${Math.floor(data.uptime / 3600)}h`);
console.log(`KBO Service: ${data.services.kboPublicSearch}`);
// Utilisation pour monitoring
if (data.status !== 'ok') {
console.warn('⚠️ API degraded or down!');
}Python
import requests
response = requests.get('https://companybelgium.be/api/health')
data = response.json()
print(f"Status: {data['status']}")
print(f"Version: {data['version']}")
print(f"Uptime: {data['uptime'] // 3600}h")
for service, status in data['services'].items():
emoji = '✅' if status == 'operational' else '⚠️'
print(f"{emoji} {service}: {status}")Exemple de réponse
200 OK
{
"status": "ok",
"version": "1.0.0",
"timestamp": "2026-02-08T12:00:00.000Z",
"uptime": 86400,
"services": {
"kboPublicSearch": "operational"
},
"responseTime": 156
}Notes
- Cet endpoint ne nécessite pas de clé API.
- Les statuts possibles sont: 'ok', 'degraded', 'down'.
- Le statut des services externes peut être: 'operational', 'degraded', 'down', 'unknown'.
- L'uptime est exprimé en secondes depuis le dernier redémarrage.
- Idéal pour le monitoring avec des outils comme UptimeRobot, Pingdom, etc.