Übersicht über die offene API-Plattform

Für Entwickler: Was ist eine offene Plattform, 5 Minuten für den Einstieg, offener Umfang, Versionsverpflichtung.

Die offene Plattform Braidrun Workflow ermöglicht es externen Systemen, den Workflow über eine stabile REST-API zu steuern: Ausführung auslösen, Ergebnisse lesen, Genehmigungsentscheidungen pushen und Produkte herunterladen. Alle öffentlichen Schnittstellen werden durch den API-Schlüssel authentifiziert – derselbe Mechanismus deckt Webhooks, Genehmigungsrückrufe und Endpunkte der offenen Plattform v1 ab.

Wer sollte verwenden

Entwickler, die Workflows in CI/CD, internen Geschäftssystemen und mobilen App-Diensten auslösen müssen
Betriebsszenario des Abschlusses der Genehmigung durch Klicken auf einen Link in Slack/Telegram/E-Mail
Ein Team, das seinen Partnern Workflow-as-a-Service bietet
Datenteams, die Ausführungsergebnisse zurück an das Data Warehouse/BI-System des Unternehmens leiten müssen

Gesamtarchitektur

text

┌──────────────────┐    Authorization: Bearer dyk_xxx     ┌──────────────────────┐
│   你的客户端     │ ───────────────────────────────────▶ │  Braidrun Workflow    │
│                  │                                       │   开放平台 v1 / Webhook │
│  - SDK / curl    │ ◀─── 200 OK + JSON ──────────────── │                      │
│  - CI/CD         │ ◀─── 429 + Retry-After ──────────── │  - 校验 scope        │
│  - 邮件链接      │ ◀─── 401 Unauthorized ───────────── │  - 速率限制          │
└──────────────────┘                                       │  - 累计用量          │
                                                            └──────────────────────┘

Ein vollständiger Aufruf einer offenen Plattform: Der Client verfügt über ein Token in der Form dyk_<id>_<secret> und trägt bei jeder Anfrage einen Bearer-Header mit; Der Server sammelt die Nutzung automatisch, nachdem er den Umfang überprüft hat. Wenn die Obergrenze der Paketrate überschritten wird, wird HTTP 429 + Retry-After zurückgegeben.

Beginnen Sie in 5 Minuten

Anmelden Braidrun-Konsole → Geben Sie „Kontoeinstellungen → API-Schlüssel“ ein.
Api-schlüssel erstellen Klicken Sie auf „Neuer API-Schlüssel“ → wählen Sie den erforderlichen Bereich aus (es wird empfohlen, zuerst WORKFLOW_READ + WORKFLOW_EXECUTE auszuwählen) → legen Sie den Gültigkeitszeitraum fest
Token kopieren Nach erfolgreicher Generierung erscheint eine einmalige Anzeige des Tokens. Kopieren Sie es und speichern Sie es sofort in Ihrem Schlüsselverwaltungstool.
Rufen Sie einen Endpunkttest auf Verwenden Sie Curl, um Ihre eigene Workflow-Liste abzurufen:

bash

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Offener Bereich

Domäne	Bereich
Webhook-trigger	Externes System → POST löst gebundene Workflow-Ausführung aus
Genehmigungs-Webhook	Genehmigung/Ablehnung mit einem Klick aus den manuellen_Genehmigungsschritten von Mail/Slack/Telegram
Workflow v1	Workflow-Definitionen auflisten/lesen; Initiieren Sie die Ausführung über die API
Führen Sie v1 aus	Ausführungsstatus abfragen/Ergebnisse lesen/Ausführung abbrechen
Genehmigung v1	Offene Genehmigungen auflisten / Genehmigungsdetails lesen / genehmigen (mit optional bearbeiteten Genehmigungsformulardaten) / manual_approval-Schritte ablehnen
Produkt v1	Listen Sie Ausführungsprodukte auf und erhalten Sie Produkt-Download-Links

Konsultieren Sie den Leitfaden

Offizielles SDK · Typsichere API-Clients für 12 Sprachen
Api-schlüsselverwaltung · Erstellung / Umfang / Widerruf / Nutzungsanalyse
Authentifizierung und Ratenbegrenzung · Drei Möglichkeiten, Header/Paketrate/Fehlercode zu schreiben
Webhook-endpunkt · Workflow-Trigger + Genehmigungsrückruf
V1-endpunktreferenz · Die vollständigen 14 v1-Endpunkte

Versionsverpflichtung

v1 ist eine stabile API-Oberfläche: Felder werden nicht destruktiv gelöscht und neue Felder können hinzugefügt werden. Wichtige Änderungen werden mit einem neuen v2-Pfadpräfix veröffentlicht und bieten einen Koexistenzzeitraum von mindestens 6 Monaten v1 → v2.