Zum Hauptinhalt springen

brokerize JavaScript client

Diese JavaScript/TypeScript-Bibliothek ist Ihr Schlüssel zur einfachen und sicheren Integration der brokerize API. Sie übernimmt die komplexen Aufgaben wie Authentifizierung, Fehlerbehandlung und Datenvalidierung, damit Sie sich auf Ihre Anwendung konzentrieren können. 🚀

Warum brokerize client?​

Der brokerize client macht die API-Integration zum Kinderspiel. Anstatt sich mit Low-Level-Details herumzuschlagen, erhalten Sie eine saubere, typsichere Schnittstelle für alle wichtigen Brokerage-Funktionen.

🔑 Hauptvorteile​

  • ⚡ Schnelle Integration – Wenige Zeilen Code für vollständige Funktionalität
  • 🔒 Sichere Authentifizierung – Automatische Verwaltung von Tokens und clientIds
  • 🛠️ Fehlerresistente Kommunikation – Robuste Fehlerbehandlung und Wiederholungslogik
  • 📱 Echtzeit-Updates – WebSocket-Unterstützung für Live-Daten
  • 🏷️ Vollständige TypeScript-Typen – Bessere Entwicklungserfahrung und weniger Bugs

Die Rolle der clientId​

Ein zentrales Element bei der Nutzung von brokerize client ist die sogenannte clientId. Sie dient als eindeutiger Bezeichner für Ihre Anwendung und ist Voraussetzung für die Authentifizierung und Autorisierung aller API-Aufrufe. Die clientId wird im Rahmen der Anbindung an brokerize vergeben und muss bei jeder Anfrage mitgesendet werden. So wird sichergestellt, dass Daten und Funktionen nur für berechtigte Mandanten zugänglich sind.

Informationen wie Sie eine clientId erhalten finden Sie unter Client ID erstellen.

Schnellstart: Integration in 3 Schritten​

Die Einbindung von brokerize client ist unkompliziert und erfordert nur wenige Minuten:

1. Installation​

Fügen Sie das Paket zu Ihrem Projekt hinzu:

npm install @brokerize/client-js

2. Initialisierung​

Konfigurieren Sie die Bibliothek mit Ihrer API-URL und clientId:

import { BrokerizeClient } from '@brokerize/client-js';

const client = new BrokerizeClient({
  apiUrl: 'https://api-preview.brokerize.com', // Oder Produktions-URL
  clientId: 'IHRE_CLIENT_ID',
});

Die clientId wird hier direkt bei der Initialisierung übergeben. Die Bibliothek kümmert sich dann automatisch darum, dass alle Anfragen korrekt signiert und zugeordnet werden.

3. Nutzung​

Sie können die bereitgestellten Methoden benutzen. Vollständige TypeScript Typ-Definitionen machen Ihnen die Entwicklung einfach.

client.createGuestUser().then(accounts => {
  // Weiterverarbeitung
});