So greifen Sie auf die API zu
Registrieren Sie eine App im B2CORE IB Back Office, wählen Sie ihre Zugriffsebene, tauschen Sie die Zugangsdaten gegen ein Zugriffstoken ein und rufen Sie die IB API auf
Integrationen greifen im Namen einer im Back Office registrierten App auf die B2CORE IB API zu. Jede App hat eine Client-ID, ein Client-Geheimnis und eine Zugriffsebene, die festlegt, ob die App Daten ändern darf. Dieser Artikel zeigt Ihnen, wie Sie eine App registrieren und Ihren ersten API-Aufruf durchführen.
App registrieren
Gehen Sie zu Introducing Brokers > Einstellungen > Apps.
Klicken Sie auf Neue App registrieren.
Geben Sie im Feld App-Name einen Namen für die App ein.
Wählen Sie die Zugriffsebene aus:
- Read-only (vorausgewählt) — die App kann alle GET-Operationen aufrufen und Exportaufträge erstellen. Alle anderen POST-, PUT-, PATCH- oder DELETE-Anfragen mit dem Zugriffstoken der App werden abgelehnt. Empfohlen für Integrationen zur Berichterstellung und Überwachung.
- Full access — die App kann alle API-Operationen aufrufen.
Sie können die Zugriffsebene später auf der Detailseite der App ändern. Die Änderung gilt ab der nächsten API-Anfrage der App.
Klicken Sie auf Speichern.
Sie werden zur Detailseite der neu erstellten App weitergeleitet. Dort können Sie App-Name, Client-ID, Client-Geheimnis, Zugriffsebene und IP-Positivliste einsehen.
Kopieren Sie Ihre Client-ID und Ihr Client-Geheimnis und bewahren Sie sie sicher auf. Sie dienen zur Überprüfung Ihrer Identität beim Zugriff auf die API. Das Client-Geheimnis wird nur einmal auf dieser Seite angezeigt — später können Sie es nicht erneut einsehen.
Zugriffstoken abrufen
Senden Sie eine POST-Anfrage an die Operation /tokens mit HTTP-Basic-Authentifizierung. Verwenden Sie die Client-ID als Benutzernamen und das Client-Geheimnis als Passwort:
curl -X POST "{baseUrl}/tokens" \
-u "CLIENT_ID:CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{"grant_type": "client_credentials"}'Ersetzen Sie {baseUrl} durch die Basis-URL Ihrer IB API, die Ihnen Ihr B2BROKER-Integrationsteam bereitstellt.
Kopieren Sie den Wert von access_token aus der Antwort. Die Antwort enthält außerdem token_type (Bearer) und expires_in — die Gültigkeitsdauer des Tokens in Sekunden. Wenn Sie ein neues Token anfordern, werden die bisherigen Token der App widerrufen.
API aufrufen
Übergeben Sie das Token bei jeder Anfrage im Header Authorization:
curl "{baseUrl}/users" \
-H "Authorization: Bearer ACCESS_TOKEN"Alle Operationen sind in der API-Referenz aufgeführt. Bei jeder Operation ist angegeben, welche Zugriffsberechtigung sie erfordert: read (für jede App verfügbar) oder write (nur für Apps mit Full access).
Was eine 403-Antwort bedeutet
Wenn eine App mit Read-only-Zugriff eine Operation aufruft, die write-Zugriff erfordert, lehnt die API die Anfrage mit HTTP 403 und folgendem Antworttext ab:
{
"error": {
"message": "This App is read-only and cannot perform this operation.",
"code": "insufficient_scope"
}
}Prüfen Sie das Feld code: insufficient_scope bedeutet, dass die Zugriffsebene der App die Ursache ist. Damit die Anfrage erfolgreich ist, stellen Sie die App unter Introducing Brokers > Einstellungen > Apps entweder auf Full access um — die Änderung gilt ab der nächsten Anfrage, ein neues Token ist nicht erforderlich — oder registrieren Sie für die Integration, die Daten ändern muss, eine separate App mit Full access.
Die einzige Ausnahme ist POST /exports/async: Apps mit Read-only-Zugriff dürfen Exportaufträge erstellen. So können Integrationen zur Berichterstellung Daten ohne Full access exportieren.
Zuletzt aktualisiert am