Einführung
Umgebungen
Section titled “Umgebungen”B2Brouter hat drei Umgebungen — für einen vollständigen Vergleich siehe Umgebungen.
| Umgebung | Base URL | Wann verwenden |
|---|---|---|
| Sandbox | https://api.b2brouter.net (Schlüsselpräfix test_) | Tägliche Entwicklung, Payload-Validierung, Onboarding |
| Staging | https://api-staging.b2brouter.net | Große Integrationen, umfangreiche End-to-End-Tests, QA-Umgebungen von Behörden |
| Production | https://api.b2brouter.net | Live-Traffic |
Beginnen Sie mit Sandbox. Das ist die empfohlene Umgebung für die erste Entwicklung und für tägliche Tests. Verwenden Sie Staging nur für große Integrationen oder umfassende End-to-End-Tests, die ein vollständiges Environment-Setup erfordern.
Erste Schritte
Section titled “Erste Schritte”Registrieren und Ihr Konto konfigurieren
Section titled “Registrieren und Ihr Konto konfigurieren”Um die B2Brouter-API zu nutzen, registrieren Sie sich unter app.b2brouter.net/en/register. Detaillierte Einrichtungsanweisungen finden Sie hier.
Nach der Registrierung melden Sie sich bei B2Brouter an und richten Ihr Konto mit einem Basic-Plan ein. Eine detaillierte Anleitung finden Sie hier.
Einen Sandbox-API-Schlüssel erhalten
Section titled “Einen Sandbox-API-Schlüssel erhalten”Öffnen Sie den Bereich Developers und erstellen Sie eine Sandbox. Ihr Sandbox-API-Schlüssel beginnt mit test_ und leitet alle Anfragen automatisch an die Sandbox-Umgebung weiter — eine separate URL ist nicht erforderlich. Siehe Sandbox für vollständige Einrichtungsanweisungen.
Aktivierung der Staging-Umgebung
Section titled “Aktivierung der Staging-Umgebung”Wenn Sie die Staging-Umgebung benötigen (große Integrationen, breite End-to-End-Tests), registrieren Sie sich unter app-staging.b2brouter.net/en/register. Staging-Konten haben zunächst eingeschränkte Berechtigungen — reichen Sie ein Support-Ticket ein, um den notwendigen Zugriff zu beantragen. Unser Team wird ihn freischalten.
Verwendung der REST-API
Section titled “Verwendung der REST-API”Gehen Sie wie folgt vor, um auf die B2Brouter-API zuzugreifen:
- Öffnen Sie Ihr Konto.
- Klicken Sie in Ihrem Konto auf den Tab Developers.
- Klicken Sie auf den API-Schlüssel, um ihn in die Zwischenablage zu kopieren.
- Um die Konto-IDs zu finden, klicken Sie auf View IDs for each account oder auf das Symbol Edit group icon neben Ihrem Gruppennamen.
- Öffnen Sie die API Reference.
Hinweis:
API-Schlüssel sind umgebungsspezifisch. Sandbox-Schlüssel (Präfix test_) funktionieren nur in der Sandbox, Produktionsschlüssel nur in Production, Staging-Schlüssel nur in Staging. Sie erhalten jeden Schlüssel, indem Sie sich in der jeweiligen Umgebung anmelden.
Standardmäßig ist die API-Referenz für die Staging-Umgebung dokumentiert. Um auf Sandbox oder Production umzuschalten, öffnen Sie das Dropdown Base URL.
Authentifizierung
Section titled “Authentifizierung”Die Zugangsdaten müssen in den Request-Headern übergeben werden, mit dem Namen X-B2B-API-Key.
API-Version
Section titled “API-Version”In B2Brouter hat jede Gruppe eine Standard-API-Version. Sie können sie im Tab Developers unter API Keys einsehen. Sie können die API-Version auch manuell in den Request-Headern mit dem Namen X-B2B-API-Version angeben. Wenn keine Version angegeben ist, verwendet B2Brouter die Standardversion der Gruppe.
Antwortformate
Section titled “Antwortformate”B2Brouter liefert Antworten nur im JSON-Format.
Konto-Identifikatoren
Section titled “Konto-Identifikatoren”Verwenden Sie den List Accounts endpoint
curl --request GET \ --url https://api-staging.b2brouter.net/accounts \ --header 'X-B2B-API-Key: {YOUR_API_KEY}' \ --header 'X-B2B-API-Version: {YOUR_API_VERSION}' \ --header 'accept: application/json'Achten Sie in dieser Antwort auf die Information im Feld identifier. Diese ID sollten Sie verwenden, wenn Sie über die API mit dem Konto interagieren möchten.
Hinweis: Sie finden die Konto-IDs auch im Tab Developers, indem Sie auf das Symbol Edit group icon neben Ihrem Gruppennamen klicken. Die Liste der Konten und ihrer IDs wird dort angezeigt.
API Rate Limiting
Section titled “API Rate Limiting”Um optimale Leistung und faire Nutzung sicherzustellen, setzt die B2Brouter-API Limits für eingehende Requests durch:
Rate Limits:
- Production: 1.000 Requests pro Minute
- Sandbox / Staging: 600 Requests pro Minute
Rate Limit überschritten: Wenn Sie das Limit überschreiten, gibt die API Folgendes zurück:
- HTTP-Statuscode
429 Too Many Requests
Best Practices:
- Implementieren Sie einen Exponential Backoff, wenn Sie
429-Antworten erhalten - Cachen Sie Antworten, wenn möglich, um API-Aufrufe zu reduzieren
- Verwenden Sie Webhooks statt Polling für Echtzeit-Updates
SDKs und Client-Bibliotheken
Section titled “SDKs und Client-Bibliotheken”Sie können die API direkt per HTTP integrieren oder ein offizielles SDK verwenden. Das erste offizielle SDK ist das PHP SDK:
Es bietet Methoden für vollständiges Rechnungsmanagement, Downloads von Dokumenten in mehreren Formaten, vollständige Tax-Report-Operationen (einschließlich Verifactu), Pagination-Utilities und Fehlerbehandlung. Im Laufe der Zeit werden weitere SDKs für andere Programmiersprachen hinzugefügt.
OpenAPI-Referenz herunterladen
Section titled “OpenAPI-Referenz herunterladen”Sie können die vollständige REST-API-Referenz im OpenAPI-Format (YAML) über die folgenden Links herunterladen: