3 API3.7
Systemzustand: GET /health
Zustand des Service und, mit Schlüssel, seiner Teile und Übermittlungswege.
- In der Sandbox
In einfachen Worten
Dieser Aufruf sagt, ob der Service läuft. Mit einem Schlüssel sagt er auch, wie es um Datenbank, Regeldateien, Warteschlange und Übermittlungswege steht.
GET /health antwortet mit 200 und status auf ok oder degraded, oder mit 503 und down, wenn die Datenbank nicht antwortet. Ohne Schlüssel enthält die Antwort nur status. Es ist der einzige Aufruf, der keinen Schlüssel braucht.
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"
}Mit Schlüssel
Ein Schlüssel fügt checks hinzu:
| Prüfung | Bedeutung |
|---|---|
database | Ob die Datenbank antwortet. |
validation_artefacts | Ob die festgelegten Regeldateien der Validierung vorhanden und aktuell sind. |
queue | Der Zustand der Arbeitswarteschlange. |
routes | Ein Eintrag je Übermittlungsweg, mit einem status, der Folge der gesehenen Fehler und den dafür gespeicherten Live-Zugangsdaten. |
Der status eines Übermittlungswegs ist ok, degraded, unreachable oder no_rail. DE-XRECHNUNG hat kein Netz und zeigt no_rail. Nichts prüft ein Netz aktiv: Der Status stammt aus den Fehlern, die der Worker gesehen hat. Ein Übermittlungsweg, an den noch niemand gesendet hat, zeigt ok, und fünf Fehler in Folge zeigen unreachable. Ein Übermittlungsweg ändert nie den eigenen status des Service; der Ausfall eines Netzes wird uns als Alarm gemeldet.
Hinweis
Sandbox
Hinter ok steht noch keine Verfügbarkeitsprüfung. Nutzen Sie es daher als Lebenszeichen und nicht als Zusage. Am 7. Okt. 2026 lief die gehostete Sandbox noch mit dem Release vor Vertrag 0.19.3. Ihre Antwort ohne Schlüssel listet daher weiterhin die fünf Übermittlungswege auf, alle not_configured, wie im Beispiel oben. Vertrag 0.19.3 und die Referenz beschreiben die Antwort nur mit status.