Developers
OpenAPI ↗
Go to the app
Documentation / Getting started
API v1 · Getting started

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.

HTTP
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 basisUse
Read · ReadRead documents, artifacts, job status, request history and delivery history.
Process · Parsing / CheckingRead documents and technically validate them.
Generate · GenerateGenerate XRechnung or ZUGFeRD invoices from structured data.
All three rightsConversion 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

EnvironmentBasic URLKeys
Sandbox/api/v1/sandboxrbx_test_…
Live live/api/v1/liverbx_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 is not a shipping ban for webhooks.

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.

The connection is restored...

New connection attempt in seconds.

The connection could not be restored.
Please try again or reload the page.

Your meeting was paused.

The sitting could not be continued.
Please try again or reload the page.