REST API¶
The Fakturia API is an OpenAPI based interface using the REST standard.
It allows developers to directly interact with our application via HTTPS exchanging data in the JSON format.
Endpoints for all API calls¶
| Production | Sandbox | |
|---|---|---|
| Endpoint | https://api.fakturia.de/api/v1/ | https://api.sandbox.fakturia.de/api/v1/ |
| API-Reference | https://api.fakturia.de/documentation/ | https://api.sandbox.fakturia.de/documentation/ |
| Swagger File | https://api.fakturia.de/api/openapi.json | https://api.sandbox.fakturia.de/api/openapi.json |
date/time format
Timestamps are handled in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss in Java)
Prerequisites¶
The API can only be accessed if the following conditions are true:
- Your Fakturia plan includes API access
- The API is activated in the backend for at least one project
- An API-Key has been generated in the backend
- The IP address of your client has been added to the IP whitelist for the project (or whitelist is empty)
Authorization¶
Include the following HTTP headers in every request to authorize against our service:
| Header variable name | value |
|---|---|
| api-key | {your api key - see project settings#api-schnittstelle-konfigurieren in the backoffice} |