REST-API · GET /health · /info · /usage · kostenlos
Diese Routen geben Auskunft über den Dienst selbst. Sie prüfen nichts und zählen nie gegen Ihr Kontingent.
Ein Programm fragt sie, bevor es arbeitet: Läuft der Dienst? Welche Validatoren bietet er an? Wie viel ist vom Kontingent noch übrig?
Anfrage
Adresse: https://invoicepress.de/wp-json/einvoice-api/v1/…
GET /health – Das Lebenszeichen. Die Antwort ist {„status“:“ok“}. Kein Schlüssel nötig.
GET /info – Welche Validatoren und Darstellungen der Dienst anbietet, in derselben Form wie die Validator Bridge, dazu server und contract, die Fassung der gemeinsamen Schnittstelle. Kein Schlüssel nötig.
GET /usage – Der Verbrauch Ihres Kontingents im laufenden Monat, je Gruppe von Routen. Braucht Ihren Schlüssel, kostet aber nichts.
GET /openapi.json – Die vollständige Beschreibung der API im OpenAPI-Format. Mit ?only=<name> kommt nur ein Teil, etwa ?only=vat. Kein Schlüssel nötig.
Beispiel
curl -X GET "https://invoicepress.de/wp-json/einvoice-api/v1/usage" \
-H "Authorization: Bearer <Schlüssel>"
Kosten
Diese Routen kosten nichts und zählen nie gegen Ihr Kontingent.
Jede Antwort mit Schlüssel trägt außerdem die Kopfzeilen X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset und X-Quota-Stage. So sieht Ihr Programm bei jedem Aufruf, wie viel noch übrig ist.