Braidrun SDK
Rufen Sie mit 13 typsicheren Clients für 12 Sprachen APIs für Workflows, Ausführungen, Artefakte, Freigaben und Webhooks auf.
Das Braidrun SDK ist die offizielle Sammlung typsicherer Clients für die offene Plattform-API. Es bildet Endpunkte für Workflows, Ausführungen, Artefakte, menschliche Freigaben und Webhooks auf vertraute Methoden und Datenmodelle der jeweiligen Sprache ab, sodass Sie HTTP-Anfragen und Antworttypen nicht selbst schreiben müssen.
Unterstützte Clients
Das Repository enthält 13 Client-Implementierungen für 12 Sprachen. Jedes Verzeichnis stellt einen eigenständigen Client mit Paketmetadaten, API-Modellen, Tests und vollständiger Endpunktdokumentation für die jeweilige Sprache bereit.
Server und Backend
Web und Node.js
Mobil und plattformübergreifend
API-Abdeckung
Jeder Sprach-Client deckt dieselben öffentlichen Funktionen ab; die Methodennamen sind an die Konventionen der jeweiligen Sprache angepasst.
| Funktionsbereich | Ihre Möglichkeiten |
|---|---|
| Workflows | Workflows auflisten und abrufen sowie eine Ausführung asynchron starten. |
| Ausführen | Status, Verlauf und Endergebnisse abfragen oder eine noch laufende Ausführung abbrechen. |
| Artefakt | Von einer Ausführung erzeugte Dateien und Artefaktmetadaten lesen. |
| Manuelle Genehmigung | Ausstehende Freigaben lesen und eine Genehmigung oder Ablehnung übermitteln. |
| Webhook | Webhooks registrieren und verwalten, Statistiken anzeigen und Workflows über Webhooks auslösen. |
Schnellstart
- Erstellen Sie unter „Kontoeinstellungen → API-Schlüssel“ einen Schlüssel und gewähren Sie nur die für Ihre Aufrufe erforderlichen Berechtigungsbereiche.
- Wählen Sie den Client aus, der zu Ihrem Technologie-Stack passt, und öffnen Sie die README-Datei in seinem Verzeichnis.
- Installieren Sie die Abhängigkeiten aus dem Quellcode und konfigurieren Sie den API-Schlüssel über eine Umgebungsvariable.
- Erstellen Sie einen API-Client und rufen Sie zuerst die Workflow-Liste ab, um Verbindung und Berechtigungen zu prüfen.
python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"import os
import braidrun_sdk
configuration = braidrun_sdk.Configuration(
host="https://braidrun.com",
access_token=os.environ["BRAIDRUN_API_KEY"],
)
with braidrun_sdk.ApiClient(configuration) as client:
workflows = braidrun_sdk.WorkflowsApi(client)
result = workflows.list_workflows()
print(result)Das SDK wird derzeit über sein GitHub-Quellcode-Repository bereitgestellt; die Verfügbarkeit in sprachspezifischen Paketmanagern kann variieren. Beachten Sie die README-Datei im jeweiligen Verzeichnis und gehen Sie nicht davon aus, dass jeder Client in einem öffentlichen Paket-Repository veröffentlicht wurde.
Authentifizierung und Berechtigungen
Laden Sie den mit dyk_ beginnenden API-Schlüssel aus einer Umgebungsvariable oder einem Secret-Management-Dienst und verwenden Sie einen Bearer-Header. Schreiben Sie einen echten Schlüssel niemals in Quellcode, Protokolle oder Frontend-Code für Browser. Jeder Endpunkt prüft weiterhin den erforderlichen Berechtigungsbereich; ein typsicherer Client gewährt nicht automatisch Berechtigungen.
Das SDK generiert auch APIs zur Webhook-Verwaltung. Die Verwaltungsendpunkte unter /api/webhooks verwenden jedoch eine Browsersitzung oder ein Administrator-Dienstkonto und akzeptieren keine standardmäßigen, fein abgestuften API-Schlüssel der offenen Plattform. Webhook-Trigger-Endpunkte können weiterhin einen Schlüssel der offenen Plattform mit dem Berechtigungsbereich WEBHOOK_TRIGGER verwenden.
Wenn die API den Status 429 zurückgibt, beachten Sie Retry-After und passen Sie mithilfe von X-RateLimit-Limit und X-RateLimit-Window das Intervall Ihrer Wiederholungsversuche an.
SDK oder Workflow-Engine?
| Projekt | Passend zur Szene | Ausführungsumgebung |
|---|---|---|
braidrun-sdk | Rufen Sie die API der Braidrun-Cloud-Plattform aus Ihrer Anwendung mit sprachspezifischen Typen und Modellen auf. | Ihre Anwendung + Braidrun-Cloud-Plattform |
braidrun-workflow | Führen Sie YAML-Workflows in Ihrer eigenen Umgebung aus oder betten Sie die Runtime in ein Kotlin/JVM-Projekt ein. | Von Ihnen verwaltete lokale, Server- oder CI-Umgebungen |
Vollständige Übersicht über beide Projekte anzeigen