3 API3.7
État du service : GET /health
L’état du service et, avec une clé, celui de ses composants et de ses canaux.
- Dans le bac à sable
En termes simples
Cet appel indique si le service fonctionne. Avec une clé, il indique aussi l’état de sa base de données, de ses fichiers de règles, de sa file d’attente et de ses canaux.
GET /health répond 200 avec status à ok ou degraded, ou 503 avec down quand la base de données ne répond pas. Sans clé, la réponse ne contient que status. C’est le seul appel qui ne nécessite pas de clé.
curl "https://api-sandbox-eu.eurinvoice.com/health"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/health"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/health', {
});
console.log(response.status);
console.log(await response.text());{
"routes": {
"FR-PA": "not_configured",
"DE-XRECHNUNG": "not_configured",
"PEPPOL": "not_configured",
"RO-EFACTURA": "not_configured",
"PL-KSEF": "not_configured"
},
"status": "ok"
}Avec une clé
Une clé ajoute checks :
| Contrôle | Signification |
|---|---|
database | Si la base de données répond. |
validation_artefacts | Si les fichiers de règles de validation épinglés sont présents et récents. |
queue | L’état de la file de travail. |
routes | Une entrée par canal, avec un status, la série d’erreurs constatées et les identifiants d’accès actifs stockés pour lui. |
Le status d’un canal est ok, degraded, unreachable ou no_rail. DE-XRECHNUNG n’a pas de réseau et affiche no_rail. Rien ne sonde un réseau : le statut vient des erreurs que le worker a vues. Un canal vers lequel personne n’a rien envoyé affiche ok, et cinq erreurs de suite affichent unreachable. Un canal ne modifie jamais le status du service lui-même ; la panne d’un réseau nous est signalée par une alerte.
Remarque
Bac à sable
Aucune sonde de disponibilité ne se trouve encore derrière ok : utilisez-le comme contrôle de fonctionnement, et non comme une promesse. Le 7 oct. 2026, le bac à sable hébergé tournait encore avec la version précédant le contrat 0.19.3 ; sa réponse sans clé énumère donc toujours les cinq canaux, tous not_configured, comme dans l’exemple ci-dessus. Le contrat 0.19.3 et la référence décrivent la réponse avec status seul.