Entwickler suchen oft nach effizienten Wegen, Finanzdienstleistungen in ihre Anwendungen zu integrieren, und die Brex API sticht als robuste Lösung für die Verwaltung von Ausgabenlimits, Transaktionen und Teamressourcen hervor. Dieser Artikel führt Sie durch den Prozess des Zugriffs und der Nutzung der Brex API. Sie werden lernen, wie man die Authentifizierung einrichtet, Endpunkte erkundet und die API in Ihre Systeme integriert.
Während Sie fortfahren, denken Sie daran, dass kleine Anpassungen in Ihrem Vorgehen, wie die Auswahl der richtigen Scopes während der Token-Generierung, den Integrationserfolg erheblich beeinflussen können. Achten Sie daher genau auf jeden Schritt, um eine nahtlose Konnektivität zu gewährleisten.
Was ist die Brex API?
Die Brex API bietet eine RESTful Schnittstelle, die es Entwicklern ermöglicht, Finanzabläufe innerhalb der Brex-Plattform zu automatisieren und anzupassen. Brex, ein Finanztechnologieunternehmen, bietet Dienste wie Firmenkreditkarten, Ausgabenverwaltung und Spesenabrechnung an. Folglich können Sie mit der Brex API programmatisch mit diesen Funktionen interagieren.
Die Brex API umfasst mehrere spezialisierte APIs, wie die Team API zur Verwaltung von Benutzern und Karten, die Transaktions-API zum Abrufen abgewickelter Transaktionen und die Onboarding-API zur Bearbeitung von Empfehlungen. Jede davon deckt unterschiedliche Aspekte des Finanzmanagements ab und ermöglicht es Ihnen, benutzerdefinierte Berichte zu erstellen, Benutzereinladungen zu automatisieren oder Ausgaben in Echtzeit zu verfolgen.
Darüber hinaus legt Brex Wert auf Sicherheit und Compliance, um sicherzustellen, dass API-Interaktionen den Industriestandards entsprechen. Wenn Sie die Brex API verwenden, erhalten Sie daher Zugang zu Tools, die skalierbare Finanzoperationen unterstützen, ohne die Datenintegrität zu gefährden.
Warum sollten Sie die Brex API verwenden?
Sie sollten die Brex API verwenden, wenn Ihre Anwendung eine Integration mit Unternehmensfinanztools erfordert. Zum Beispiel müssen Finanzteams oft Transaktionsdaten mit Buchhaltungssoftware synchronisieren, und die Brex API erleichtert dies, indem sie Endpunkte zum Auflisten von Transaktionen und Konten bereitstellt.
Darüber hinaus reduziert die API den manuellen Aufwand bei der Verwaltung von Ausgabenlimits und Benutzerzugriffen. Sie können die Kartenerstellung automatisieren, monatliche Limits festlegen und Aktivitäten überwachen, was die Abläufe für wachsende Unternehmen optimiert. Zusätzlich können Partner im Rechnungswesen oder HR die Onboarding API nutzen, um personalisierte Empfehlungslinks zu erstellen und so die Kundenakquise zu verbessern.
Der wahre Wert liegt jedoch in ihrer Flexibilität. Sie integrieren die Brex API in bestehende Systeme, um benutzerdefinierte Dashboards oder Benachrichtigungen zu erstellen, wodurch sichergestellt wird, dass Finanzdaten effizient über Plattformen hinweg fließen. Dadurch sparen Entwickler Zeit und reduzieren Fehler im Vergleich zur manuellen Dateneingabe.
Wie starten Sie mit dem Brex API-Zugang?
Um mit dem Brex API-Zugang zu beginnen, registrieren Sie sich zunächst für ein Brex-Konto, falls Sie noch keines haben. Besuchen Sie brex.com und erstellen Sie ein Konto als Administrator, da nur Kontoadmins oder Kartenadmins API-Tokens generieren können.
Melden Sie sich anschließend beim Brex-Dashboard an.
Navigieren Sie zum Abschnitt "Entwickler" unter "Einstellungen". Dort klicken Sie auf "Token erstellen", um den Vorgang zu starten. Sie geben einen Namen für das Token an, der später hilft, seinen Zweck zu identifizieren, z.B. "Integrations-Token für App".
Darüber hinaus wählen Sie in diesem Schritt die entsprechenden Scopes aus. Scopes definieren die Datenzugriffsebenen, wie z.B. Lesezugriff auf Transaktionen oder Schreibberechtigungen für die Benutzerverwaltung. Nachdem Sie Ihre Auswahl bestätigt haben, klicken Sie auf "Zugriff erlauben", und das System generiert das Token.
Wichtig ist, dass Sie dieses Token sofort sicher kopieren und speichern, da Brex es nach der Erstellung aus Sicherheitsgründen unkenntlich macht. Sollten Sie es verlieren, erstellen Sie einfach ein neues. Tokens verfallen nach 90 Tagen Inaktivität, daher sollten Sie die Nutzung überwachen, um Unterbrechungen zu vermeiden.
Sobald Sie das Token haben, testen Sie die grundlegende Konnektivität. Sie verwenden beispielsweise ein Tool wie curl, um eine einfache GET-Anfrage an einen Endpunkt zu stellen, wobei Sie das Token im Authorization-Header einschließen. Dies überprüft, ob Ihre Einrichtung korrekt funktioniert.
Wie authentifiziert man sich mit der Brex API?
Sie authentifizieren sich bei der Brex API mithilfe von Bearer-Tokens. Konkret fügen Sie das Token in den Authorization-Header jeder Anfrage ein, formatiert als "Bearer {Ihr_Token}".
Betrachten Sie zum Beispiel dieses curl-Beispiel:
curl -X GET https://platform.brexapis.com/v2/users/me \
-H "Authorization: Bearer bxt_jBWQLZXtu1f4sVT6UjaWPp7Gh9nVGjzEZgRX"
Diese Anfrage ruft die Details des aktuellen Benutzers ab. Ist sie erfolgreich, gibt sie JSON-Daten über den Benutzer zurück.
Darüber hinaus unterstützt Brex Benutzertoken, die an spezifische Administratorrechte gebunden sind. Sie generieren diese Token wie zuvor beschrieben und stellen sicher, dass Sie Scopes wählen, die Ihren Anforderungen entsprechen. Wenn Sie beispielsweise Karten verwalten möchten, wählen Sie Scopes für Lese- und Schreibzugriff auf Karten-Endpunkte.
Sollte ein Token jedoch kompromittiert werden, widerrufen Sie es sofort auf der Entwicklerseite im Dashboard. Widerrufene Tokens führen dazu, dass nachfolgende API-Aufrufe mit einem 401-Fehler fehlschlagen, was Ihr Konto schützt.
In der Praxis implementieren Sie die Token-Verwaltung in Ihrem Anwendungscode. Bibliotheken wie Pythons `requests`-Modul vereinfachen dies:
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
response = requests.get('https://platform.brexapis.com/v2/users/me', headers=headers)
print(response.json())
Dieses Code-Snippet demonstriert die aktive Authentifizierung in einem Skript.
Was sind die wichtigsten Brex API-Endpunkte?
Die Brex API bietet verschiedene Endpunkte über mehrere APIs hinweg. Sie beginnen mit der Erkundung der Team API, die Benutzer, Abteilungen, Standorte, Karten und mehr verwaltet.
- Für Benutzer listen Sie alle Benutzer mit GET /v2/users auf, filterbar nach E-Mail oder ID. Parameter umfassen `cursor` für die Paginierung und `limit` zur Steuerung der Antwortgröße. Ebenso laden Sie einen neuen Benutzer über POST /v2/users ein, indem Sie `first_name`, `last_name`, `email` und optional `manager_id` angeben.
Darüber hinaus aktualisieren Sie Benutzer mit PUT /v2/users/{id}, indem Sie den Status auf ACTIVE oder DISABLED ändern. Sie legen auch monatliche Limits mit POST /v2/users/{id}/limit fest, wobei Sie den Betrag im Body angeben.
- Für Abteilungen erstellen Sie eine mit POST /v2/departments, wobei ein Name erforderlich ist. Sie listen sie über GET /v2/departments auf und rufen spezifische Details mit GET /v2/departments/{id} ab.
- Standorte folgen einem ähnlichen Muster: POST /v2/locations für die Erstellung, GET /v2/locations für die Auflistung.
- Titel, die Stellenbezeichnungen darstellen, verwenden Endpunkte wie POST /v2/titles und GET /v2/titles/{id}.
- Karten sind ein Kernbestandteil. Sie listen Karten mit GET /v2/cards auf, gefiltert nach `user_id`. Um eine Karte zu erstellen, verwenden Sie POST /v2/cards mit Details wie `owner`, `card_type` (VIRTUELL oder PHYSISCH) und `spend_controls`. `spend_controls` umfassen `limit_type` und `amounts`.
Darüber hinaus aktualisieren Sie Karten über PUT /v2/cards/{id}, sperren sie mit POST /v2/cards/{id}/lock (unter Angabe eines Grundes wie BETRUG) oder kündigen sie mit POST /v2/cards/{id}/terminate.
- Sensible Operationen umfassen GET /v2/cards/{id}/pan für Kartennummern und POST /v2/cards/{id}/secure_email, um Details sicher zu versenden.
- Juristische Personen und Unternehmen haben schreibgeschützte Endpunkte wie GET /v2/legal_entities und GET /v2/company.
- Wenn Sie zur Transaktions-API wechseln, rufen Sie abgewickelte Kartentransaktionen mit GET /v2/transactions/card/primary ab, wobei Parameter wie `posted_at_start` zur Datumsfilterung verwendet werden. Für Bargeldkonten listet GET /v2/transactions/cash/{id} Transaktionen auf.
- Konto-Endpunkte umfassen GET /v2/accounts/card für Kartenkonten und GET /v2/accounts/cash für Bargeldkonten. Sie rufen Kontoauszüge mit GET /v2/accounts/card/primary/statements ab.
- Die Onboarding API konzentriert sich auf Empfehlungen. Sie erstellen Empfehlungen mit POST /v1/referrals, indem Sie `referral_code` und Bewerberdetails angeben. Listen Sie sie über GET /v1/referrals auf und erhalten Sie spezifische Details mit GET /v1/referrals/{id}. Dokumenten-Uploads verwenden POST /v1/referrals/{id}/document_upload.
Weitere APIs umfassen Payments für Überweisungen (GET /v2/transfers), Webhooks für Benachrichtigungen und die Fields API zur Verwaltung benutzerdefinierter Felder.
Alle Listen-Endpunkte unterstützen die Paginierung mit `cursor` und `limit`, was eine effiziente Datenabfrage gewährleistet.
Wie verwendet man die Brex API für Transaktionen?
Sie verwenden die Brex API für Transaktionen, indem Sie Endpunkte in der Transaktions-API aufrufen. Zuerst identifizieren Sie den Kontotyp – Karte oder Bargeld.
Für Kartentransaktionen senden Sie GET /v2/transactions/card/primary. Dies gibt abgewickelte Käufe, Rückerstattungen und Rückbuchungen zurück. Sie filtern nach `user_ids` oder `posted_at_start`, z.B. "2025-01-01T00:00:00Z".
Die Antwort enthält Details wie Betrag, Beschreibung, Händler und `expense_id`, falls erweitert.
Für Bargeldtransaktionen geben Sie die Konto-ID in GET /v2/transactions/cash/{id} an. Dies listet alle Aktivitäten für dieses Bargeldkonto auf.
Um Konten zu verwalten, listen Sie Kartenkonten mit GET /v2/accounts/card auf, das IDs und Status zurückgibt. Ebenso liefert GET /v2/accounts/cash Details zu Bargeldkonten.
Darüber hinaus rufen Sie Kontoauszüge für Prüfungszwecke ab. Verwenden Sie GET /v2/accounts/card/primary/statements, um finalisierte Kartenkontoauszüge zu erhalten, bei Bedarf paginiert.
Im Code implementieren Sie dies wie folgt (Python-Beispiel):
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
params = {
'posted_at_start': '2025-12-01T00:00:00Z',
'limit': 50
}
response = requests.get('https://platform.brexapis.com/v2/transactions/card/primary', headers=headers, params=params)
transactions = response.json()['items']
for tx in transactions:
print(f"Amount: {tx['amount']['amount']}, Description: {tx['description']}")
Dieses Skript ruft die neuesten Transaktionen ab und druckt sie aus, was die praktische Anwendung demonstriert.
Zusätzlich behandeln Sie Fehler wie 404 für ungültige IDs, indem Sie `response.status_code` überprüfen.
Wie verwaltet man Teams mit der Brex Team API?
Sie verwalten Teams mithilfe der Endpunkte der Team API. Beginnen Sie, indem Sie Benutzer mit GET /v2/users auflisten. Dies hilft Ihnen, aktuelle Teammitglieder zu prüfen.
Um einen Benutzer hinzuzufügen, verwenden Sie POST /v2/users mit den erforderlichen Feldern:
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"department_id": "dept_123"
}
Das System sendet automatisch eine Einladungs-E-Mail.
Sie aktualisieren Benutzerdetails, wie z.B. die Zuweisung eines neuen Managers, über PUT /v2/users/{id}.
Für die Ausgabenkontrolle legt POST /v2/users/{id}/limit monatliche Budgets fest.
Abteilungen und Standorte verbessern die Organisation. Sie erstellen eine Abteilung mit POST /v2/departments:
{
"name": "Engineering",
"description": "Software development team"
}
Weisen Sie dann Benutzer bei der Einladung oder Aktualisierung zu.
Karten sind an Benutzer gebunden. Sie erstellen eine virtuelle Karte für einen Benutzer:
{
"owner": {
"user_id": "user_456"
},
"card_name": "Project Card",
"card_type": "VIRTUAL",
"limit_type": "CARD",
"spend_controls": {
"limit": {
"amount": 5000,
"currency": "USD"
}
}
}
Senden Sie dies als POST an /v2/cards.
Später sperren Sie eine Karte bei Bedarf: POST /v2/cards/{id}/lock mit dem Grund "OTHER".
Dieser Ansatz gewährleistet ein sicheres Teammanagement.
Brex API in Ihre Anwendung integrieren: Codebeispiele
Sie integrieren die Brex API, indem Sie API-Aufrufe in Ihren Code einbinden. Verwenden Sie Bibliotheken wie `requests` in Python oder `axios` in JavaScript.
Für ein Node.js-Beispiel installieren Sie `axios`:
npm install axios
Danach rufen Sie Benutzer ab:
const axios = require('axios');
const headers = {
Authorization: 'Bearer your_token_here'
};
axios.get('https://platform.brexapis.com/v2/users', { headers })
.then(response => {
console.log(response.data.items);
})
.catch(error => {
console.error(error.response.data);
});
Dies protokolliert Benutzerdaten.
Für komplexere Integrationen verwenden Sie Webhooks. Abonnieren Sie Ereignisse über die Webhooks API und richten Sie Endpunkte ein, um Benachrichtigungen über Transaktionsaktualisierungen zu erhalten.
In Python handhaben Sie die Paginierung für große Datensätze:
def fetch_all_users(headers, cursor=None):
users = []
while True:
params = {'limit': 100, 'cursor': cursor}
response = requests.get('https://platform.brexapis.com/v2/users', headers=headers, params=params)
data = response.json()
users.extend(data['items'])
cursor = data['next_cursor']
if not cursor:
break
return users
Diese Funktion ruft alle Benutzer iterativ ab.
Sie sichern auch sensible Daten, wie Kartennummern, indem Sie GET /v2/cards/{id}/pan nur bei Bedarf verwenden und nichts lokal speichern.
Wie können Sie die Brex API mit Apidog testen?
Sie testen die Brex API effektiv mit Apidog, einer All-in-One-Plattform für die API-Entwicklung. Apidog ermöglicht es Ihnen, APIs intuitiv zu entwerfen, zu debuggen, zu mocken, zu testen und zu dokumentieren.
Als Nächstes richten Sie die Authentifizierung ein, indem Sie Ihr Bearer-Token in den globalen Variablen oder Umgebungseinstellungen hinzufügen. Dies gilt für alle Anfragen.
Sie senden dann Anfragen, wie GET /v2/users/me, und sehen die Antworten in einer benutzerfreundlichen Oberfläche. Apidog hebt JSON-Strukturen und Fehler hervor.
Darüber hinaus erstellen Sie Testszenarien mit Assertions. Beispielsweise können Sie prüfen, ob eine Transaktionsantwort den Status 200 hat und 'amount' enthält.
Die Mocking-Funktion von Apidog simuliert Antworten für nicht verfügbare Endpunkte und unterstützt so die Entwicklung.
Zusätzlich generieren Sie Dokumentation mit Codebeispielen in mehreren Sprachen und teilen diese mit Ihrem Team.
Durch die Verwendung von Apidog optimieren Sie das Testen der Brex API und erkennen Probleme frühzeitig.
Was sind bewährte Verfahren für die Verwendung der Brex API?
Sie befolgen bewährte Verfahren, um die Nutzung der Brex API zu optimieren. Verwenden Sie immer HTTPS und speichern Sie Tokens sicher, z.B. in Umgebungsvariablen oder Tresoren.
- Implementieren Sie die Handhabung von Ratenbegrenzungen, da Brex Limits durchsetzt – versuchen Sie es bei 429-Fehlern mit exponentiellem Backoff erneut.
- Paginieren Sie Anfragen, um Timeouts zu vermeiden; verwenden Sie `cursor` und `limit` konsistent.
- Überwachen Sie den Token-Verfall und automatisieren Sie die Erneuerung.
- Validieren Sie Eingaben vor dem Senden, um 400-Fehler zu vermeiden.
- Protokollieren Sie API-Aufrufe zum Debugging, anonymisieren Sie jedoch sensible Daten.
- Verwenden Sie Idempotenzschlüssel für POST/PUT, um Duplikate zu vermeiden.
- Integrieren Sie Fehlerbehandlung: Ordnen Sie HTTP-Codes Aktionen zu, wie das Aktualisieren von Tokens bei 401.
- Testen Sie in Staging-Umgebungen vor der Produktion.
- Bleiben Sie mit dem Brex-Changelog für Änderungen auf dem Laufenden.
Diese Verfahren gewährleisten zuverlässige Integrationen.
Häufige Probleme und wie man Brex API-Probleme behebt?
Sie stoßen auf Probleme wie Authentifizierungsfehler. Wenn Sie 401 erhalten, überprüfen Sie die Token-Gültigkeit – generieren Sie es bei Ablauf neu.
- Bei 403 Forbidden überprüfen Sie, ob die Scopes mit dem Endpunkt übereinstimmen.
- 404 Not Found bedeutet oft ungültige IDs; überprüfen Sie die Pfade doppelt.
- Ratenbegrenzung überschritten führt zu 429; implementieren Sie Backoff.
- Netzwerkfehler erfordern Wiederholungslogik.
Verwenden Sie Brex Postman Collections für erste Tests, indem Sie diese von deren Workspace forken.
Wenn Probleme weiterhin bestehen, konsultieren Sie die Dokumentation oder kontaktieren Sie den Support.
Fazit
Sie verstehen nun umfassend, wie Sie auf die Brex API zugreifen und sie nutzen können. Von der Authentifizierung über die Endpunktnutzung bis hin zum Testen mit Apidog ermöglichen diese Schritte robuste Integrationen. Wenden Sie sie an, um Ihre Finanzabläufe effizient zu verbessern.
