連携(Zapier、Make ほか)

badges.ninja を、すでに使っているツールに接続しましょう——他の場所で何かが起きたときに自動でクレデンシャルを発行し、クレデンシャルが発行、配信、失効、閲覧されたときにリアルタイムで反応できます。REST と webhooks を話せるプラットフォームであれば何でも動作します。Zapier と Make が最も手早い方法です。

自動化できること

トリガー(badges.ninja → あなたのツール)——次のときにワークフローを起動します:

クレデンシャルが発行された
クレデンシャルが配信された(そのメールが送信された)
クレデンシャルが失効した
クレデンシャルが初めて閲覧された

アクション(あなたのツール → badges.ninja):

クレデンシャルを発行する——受信者にバッジを授与します

前提条件

ダッシュボードの API キー で API キー を作成します。アクション(発行)には読み書きキーを使い、トリガーのみなら読み取り専用キーで十分です。API キーを参照してください。
以上です——すべては REST API と webhooks 上で動作します。

Zapier

badges.ninja の Zapier アプリを接続したら:

アカウントを接続 ——プロンプトが表示されたら API キーを貼り付けます。
トリガーを選択(例:Credential Issued)するか、Issue Credential アクションを選びます。
フィールドをマッピングして Zap をオンにします。

内部的には、トリガーは Webhooks API に支えられた Zapier の REST Hook モデルを使用します:Zapier は POST /webhooks で購読し、badges.ninja がリアルタイムでイベントを配信するため、ポーリングの遅延がありません。

Make(Integromat)とカスタムプラットフォーム

アプリは不要——直接つなぎます:

すべてのリクエストで X-Api-Key ヘッダーを使って認証します。

エンドポイントを登録してイベントを購読します:

bash

curl -X POST https://api.badges.ninja/webhooks \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://hook.example.com/badges", "events": ["credential.issued"] }'

あなたのエンドポイントで署名付きの配信を受信します。X-Bws-Signature ヘッダーを検証してください——Webhooks を参照してください。
POST /awards を呼び出して クレデンシャルを発行 します——Awards API を参照してください。

リファレンス

Webhooks API — イベント、ペイロード、署名、再試行
Awards API — クレデンシャルの発行
API キー — キーとアクセススコープ

Zapier アプリのソースはリポジトリの integrations/zapier/ にあり、Zapier CLI でプッシュできます。

連携(Zapier、Make ほか) ​

自動化できること ​

前提条件 ​

Zapier ​