Docs

3 API3.7

3.7

Stan usługi: GET /health

Stan usługi, a z kluczem także stan jej części i kanałów.

  • W sandboxie

Prostymi słowami

To wywołanie informuje, czy usługa działa. Z kluczem podaje też, jak radzą sobie jej baza danych, pliki reguł, kolejka i kanały.

GET /health zwraca 200 ze status ustawionym na ok lub degraded albo 503 z wartością down, gdy baza danych nie odpowiada. Bez klucza odpowiedź zawiera tylko status. To jedyne wywołanie, które nie wymaga klucza.

curl "https://api-sandbox-eu.eurinvoice.com/health"
Odpowiedź200 OK
{
  "routes": {
    "FR-PA": "not_configured",
    "DE-XRECHNUNG": "not_configured",
    "PEPPOL": "not_configured",
    "RO-EFACTURA": "not_configured",
    "PL-KSEF": "not_configured"
  },
  "status": "ok"
}
Zarejestrowano 7 paź 2026.

Z kluczem

Klucz dodaje checks:

KontrolaZnaczenie
databaseCzy baza danych odpowiada.
validation_artefactsCzy przypięte pliki reguł walidacji są obecne i aktualne.
queueStan kolejki zadań.
routesJeden wpis na kanał, ze status, serią zaobserwowanych błędów i zapisanymi dla niego aktywnymi danymi dostępowymi.

status kanału to ok, degraded, unreachable lub no_rail. DE-XRECHNUNG nie ma sieci i ma wartość no_rail. Nic nie sonduje sieci: status wynika z błędów, które zaobserwował proces roboczy. Kanał, do którego nikt nie wysyłał, ma wartość ok, a pięć błędów z rzędu daje unreachable. Kanał nigdy nie zmienia status samej usługi; awaria sieci jest zgłaszana nam jako alert.

Uwaga

Sandbox

Za ok nie stoi jeszcze żadna sonda dostępności, więc należy go traktować jako kontrolę, że usługa działa, a nie jako obietnicę. 7 paź 2026 hostowany sandbox nadal działał na wydaniu sprzed kontraktu 0.19.3, więc jego odpowiedź bez klucza nadal wymienia pięć kanałów, wszystkie not_configured, jak w przykładzie powyżej. Kontrakt 0.19.3 i dokumentacja referencyjna opisują odpowiedź tylko z status.

Na tej stronie