Authentication
API keys, permissions and separate environments.
On this page
Server-side API access
Each request to API v1 requires a Bearer key. session cookies from the app do not entitle you to call API.
Authorization: Bearer rbx_test_…Use keys exclusively on the server, and do not store them in the frontend, mobile apps, public examples, or source code.
Appropriate allocation of permissions
| Legal basis | Use |
|---|---|
| Read · Read | Read documents, artifacts, job status, request history and delivery history. |
| Process · Parsing / Checking | Read documents and technically validate them. |
| Generate · Generate | Generate XRechnung or ZUGFeRD invoices from structured data. |
| All three rights | Conversion checks, explicit conversion confirmation and manual retry endpoints. |
Background orders always require in addition to the respective right of action ReadThe sample webhook receiver requires only one key with reader rights.
Sandbox and Live
| Environment | Basic URL | Keys |
|---|---|---|
| Sandbox | /api/v1/sandbox | rbx_test_… |
| Live live | /api/v1/live | rbx_live_… |
Keys, documents, idem potency, limits, orders and webhook recipients are separated. Sandbox invoices generated are given a TEST number and a test note. Original files uploaded remain unchanged.
Sandbox events are also delivered to real recipients if the operator: Webhooks:CaptureOnly=false has ceased.
Managing keys
Owners and administrators create, revoke and revoke keys under Integration → Developer · API & sandboxThe full key is displayed once; Rebilix stores its hash.
Expiration, revocation, account suspension, a changed security stamp or the loss of the creator's administrator permission block access. New background processing and document commit check this permission again.