3 API3.7
Status van de dienst: GET /health
De status van de dienst en, met een sleutel, die van haar onderdelen en verzendkanalen.
- In de sandbox
In gewone woorden
Deze aanroep zegt of de dienst draait. Met een sleutel zegt hij ook hoe de database, de regelbestanden, de wachtrij en de verzendkanalen ervoor staan.
GET /health antwoordt 200 met status op ok of degraded, of 503 met down als de database niet antwoordt. Zonder sleutel bevat het antwoord alleen status. Het is de enige aanroep die geen sleutel vereist.
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"
}Met een sleutel
Een sleutel voegt checks toe:
| Controle | Betekenis |
|---|---|
database | Of de database antwoordt. |
validation_artefacts | Of de vastgezette regelbestanden voor de validatie aanwezig en recent zijn. |
queue | De toestand van de wachtrij. |
routes | Eén item per verzendkanaal, met een status, de reeks geziene fouten en de actieve toegangsgegevens die ervoor zijn opgeslagen. |
De status van een verzendkanaal is ok, degraded, unreachable of no_rail. DE-XRECHNUNG heeft geen netwerk en staat op no_rail. Niets controleert een netwerk: de status komt van de fouten die de worker heeft gezien. Een verzendkanaal waarnaar nog niemand heeft verstuurd, staat op ok, en vijf fouten achter elkaar geven unreachable. Een verzendkanaal verandert nooit de eigen status van de dienst; een storing bij een netwerk wordt als alarm aan ons gemeld.
Opmerking
Sandbox
Achter ok zit nog geen uptimecontrole. Gebruik het dus als controle op teken van leven en niet als belofte. Op 7 okt. 2026 draaide de gehoste sandbox nog de release van vóór contract 0.19.3, dus haar antwoord zonder sleutel noemt nog steeds de vijf verzendkanalen, allemaal not_configured, zoals in het voorbeeld hierboven. Contract 0.19.3 en de referentie beschrijven het antwoord alleen met status.