Service routes – /health, /info, /usage

REST-API · GET /health · /info · /usage · free

Service routes: information about the service, at no cost.

These routes give information about the service itself. They check nothing and never count against your quota.

A program asks them before it starts working: Is the service running? Which validators does it offer? How much of the quota is left?


Request

The routes at a glance

Address: https://invoicepress.de/wp-json/einvoice-api/v1/…

The routes

GET /health – The sign of life. The answer is {“status”:”ok”}. No key needed.

GET /info – Which validators and renderings the service offers, in the same form as the Validator Bridge, plus server and contract, the version of the shared interface. No key needed.

GET /usage – The usage of your quota in the current month, per group of routes. Needs your key, but costs nothing.

GET /openapi.json – The full description of the API in OpenAPI format. With ?only=<name> you get only a part, e.g. ?only=vat. No key needed.


Example

A call with curl

curl -X GET "https://invoicepress.de/wp-json/einvoice-api/v1/usage" \
     -H "Authorization: Bearer <key>"

Cost

Quota and plan

These routes cost nothing and never count against your quota.

Every answer to a call with a key also carries the headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-Quota-Stage. So your program sees with every call how much is left.