APIオープンプラットフォームの概要

Braidrun Workflow オープン プラットフォームを使用すると、外部システムが安定した REST API を通じてワークフローを駆動できるようになり、実行のトリガー、結果の読み取り、承認決定のプッシュ、製品のダウンロードが可能になります。すべてのパブリック インターフェイスは API キーによって認証されます。同じメカニズムが Webhook、承認コールバック、オープン プラットフォーム v1 エンドポイントをカバーします。

誰が使うべきか

• CI/CD、社内ビジネス システム、モバイル アプリ サービスでワークフローをトリガーする必要がある開発者
• Slack/Telegram/メールからリンクをクリックして承認完了する運用シナリオ
• Workflow-as-a-Service をパートナーに提供するチーム
• 実行結果をエンタープライズ データ ウェアハウス/BI システムに戻す必要があるデータ チーム

全体的なアーキテクチャ

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

完全なオープン プラットフォーム呼び出し: クライアントは dyk_<id>_<secret> の形式でトークンを保持し、各リクエストでベアラー ヘッダーを運びます。サーバーはスコープを確認した後、使用量を自動的に蓄積します。パッケージレートの上限を超えた場合は、HTTP 429 + Retry-After が返されます。

5分以内に始めましょう

1. ログイン Braidrun コンソール → 「アカウント設定 → API キー」を入力
2. APIキーの作成 「新しい API キー」をクリック → 必要なスコープを選択 (最初に WORKFLOW_READ + WORKFLOW_EXECUTE を選択することをお勧めします) → 有効期間を設定します
3. トークンのコピー 生成が成功すると、トークンの 1 回限りの表示がポップアップ表示されます。それをすぐにコピーしてキー管理ツールに保存します。
4. エンドポイントテストを呼び出す curl を使用して独自のワークフロー リストを取得します。

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

オープンレンジ

ガイドに相談してください

• 公式 SDK · 12 言語対応のタイプセーフな API クライアント
• APIキー管理 · 作成/スコープ/失効/使用状況分析
• 認証とレート制限 · ヘッダー/パッケージレート/エラーコードの3つの書き方
• Webhook エンドポイント · ワークフロートリガー + 承認コールバック
• v1 エンドポイントリファレンス · 全 14 種類の v1 エンドポイント