Technische Details

In diesem Abschnitt finden Sie weiterführende technische Informationen zur brokerize API, die für eine robuste und fehlerfreie Integration wichtig sind.

👤 Benutzerkonten und Integration

• Jede API-Anfrage wird im Kontext eines Endnutzers ausgeführt, der mit Ihrer Anwendung interagiert.
• Empfehlung: Rufen Sie die API direkt vom Frontend aus auf. So muss Ihr Backend keine Zugriffstokens oder sensiblen Nutzerdaten verarbeiten und sendet keine Orders an Broker.
• Für Webanwendungen ist in der Regel eine CORS-Konfiguration erforderlich, die unkompliziert an die Client-Konfiguration angehängt werden kann. Wenn Sie die API aus Ihrem Backend aufrufen müssen, kontaktieren Sie bitte unseren Support, um Ihren Use Case und mögliche Optionen zu besprechen.

Gastnutzer-Modell

Alle Endnutzer greifen als anonyme Gastnutzer auf die API zu. Ein neuer Gastnutzer kann über den Endpunkt CreateGuestUser angelegt werden.

• Gastnutzer sind standardmäßig temporär. Die Gültigkeitsdauer hängt von der Client-Konfiguration ab und beträgt typischerweise etwa einen Tag.
• Die Laufzeit kann automatisch verlängert werden, solange der Nutzer aktiv ist.
• Inaktivitäts-Timeouts und maximale Laufzeiten sind konfigurierbar und werden in Abstimmung mit dem brokerize Support festgelegt.

Langfristiger Gastzugang (RecoveryPhrase)

Zufällig generierte RecoveryPhrases ermöglichen es Gastnutzern, ihre Daten langfristig im brokerize Backend zu behalten, ohne ihre Identität offenzulegen. Nutzer können jederzeit über ihre RecoveryPhrase erneut auf ihr Konto zugreifen.

Registrierte Nutzer

Registrierte (E-Mail-basierte) Nutzerkonten werden nur für bestimmte administrative Endpunkte unterstützt (z. B. Client-Management oder Download von Order-Reports) und sind für die meisten Client-Anwendungen nicht erforderlich.

UserAccessTokens

UserAccessTokens bieten fein granulare Berechtigungen (z. B. für automatisierte Aufgaben) und unterscheiden sich von RecoveryPhrases, die primär zur Anmeldung auf neuen Geräten/Browsern dienen. Typische Einsatzzwecke sind:

• Automatisierter Download von Reports
• Zugriff auf Portfoliodaten
• Ausführung anderer automatisierter Benutzeraktionen

🚦 Rate Limits

Zum Schutz der Plattform implementiert brokerize Rate Limits:

• Standard-Limit: Aktuell gilt ein Limit von 100 Anfragen pro 10 Sekunden pro Kombination aus Client-ID und Benutzer-ID für alle Endpunkte.
• Gast-User Erstellung: Für den Endpunkt CreateGuestUser (der ohne Token zugänglich ist) gilt ein IP-basiertes Limit von 1 Anfrage pro 10 Sekunden.

Umgang mit Rate Limits

Sollte Ihre Anwendung das Limit überschreiten, antwortet die API mit dem HTTP-Statuscode 429 (Too Many Requests).

• Prüfen Sie den Retry-After Header, um zu erfahren, wie lange gewartet werden muss.
• Implementieren Sie in Ihrem Client ein entsprechendes "Backoff"-Verhalten.

🆔 Request IDs

Der brokerize-Backend weist jeder Anfrage eine eindeutige ID zu und gibt diese im Header x-request-id zurück.

• Fehlersuche: Diese ID ist extrem hilfreich bei der Analyse von Fehlern. Wir empfehlen, die requestId bei unerwarteten Fehlern zu loggen oder dem Benutzer anzuzeigen, damit unser Support Anfragen im Backend präzise nachverfolgen kann.
• Interne Serverfehler: Bei Fehlern (Status 500) ist die ID oft auch Teil des JSON-Bodys der Antwort.

🔐 Privilegierte Clients (Client Secrets)

Die brokerize API ist primär für den direkten Zugriff aus Browsern und Apps konzipiert. In manchen Fällen (z.B. reine Backend-zu-Backend-Integrationen) können Rate Limits erhöht werden.

In diesen Fällen kann ein Client Secret verwendet werden, das über den Header x-brkrz-client-secret mitgesendet wird. Kontaktieren Sie unser Partnerteam, falls Sie ein solches Secret benötigen.

🔗 Broker anbinden und Daten synchronisieren

Nutzer verbinden ihre Broker-Konten entweder über die offizielle brokerize UI oder über die Oberfläche Ihrer App mit ihren Broker-Zugangsdaten.

• Verfügbare Broker ermitteln Sie über GetBrokers.
• Ein Nutzer kann über AddSession einen Login hinzufügen. brokerize speichert dabei niemals Zugangsdaten, sondern ausschließlich vom Broker ausgegebene Tokens/Sitzungs-IDs. Diese werden verworfen, sobald der Nutzer sich über LogoutSession abmeldet.
• Nach dem Verbinden werden Portfolios, Positionen und Orders des Nutzers in das brokerize Konto synchronisiert und in der Datenbank abgelegt. Die Daten bleiben verfügbar, auch wenn die Session getrennt wurde, bis der Nutzer sie aktiv löscht (z. B. DeletePortfolio).
• Daten werden im Hintergrund regelmäßig synchronisiert; Clients können optional eine Synchronisierung über TriggerSessionSync anfordern.

🪙 Handelbare Wertpapiere

Normalerweise werden alle handelbaren Wertpapiere über ihre ISIN identifiziert. Für Instrumente ohne ISIN (wie Krypto-Assets) verwendet brokerize spezielle Kürzel. Details hierzu finden Sie im Artikel Handelbare Wertpapiere.

🔄 Trade Flow (Ablauf eines Trades)

Der Ablauf eines Trades kann komplex sein, da er verschiedene Zustände beim Broker durchläuft (z.B. TAN-Freigabe, Order-Validierung). brokerize abstrahiert diesen Prozess weitgehend. Details zum spezifischen Flow und den benötigten Berechtigungen finden Sie in der API-Referenz unter GetAuthInfo.