API キー

API キーは、badges.ninja の REST API にプログラムからアクセスするための鍵です。自分のアプリケーションからバッジの作成・発行・管理を自動化するために使います。

API キーの作成

1. サイドバーから API キー ページを開きます。
2. API キーを作成 をクリックすると、インラインフォームが開きます。

3. キーに名前を付けて 作成 をクリックします。完全なキーは緑色のバナーで 一度だけ 表示されます。

4. すぐにキーをコピーしてください — 表示は一度きりです。失った場合は新しく作成する必要があります。バナーを閉じた後は、プレフィックスのみが保存されます。

アクセススコープ

キーを作成するとき、読み取り専用 にするか、フルアクセスのままにするかを選べます:

スコープ	許可される操作
フルアクセス(デフォルト)	読み取り および 書き込み — データの一覧取得、作成、発行、更新、削除。
読み取り専用	安全な GET リクエストのみ。データを変更するリクエスト(POST、PUT、PATCH、DELETE)は 403 Forbidden で拒否されます。

データを 読み取る だけでよい連携(レポート、ダッシュボード、バックアップ)には読み取り専用キーを使用してください。そうすればキーが漏洩しても何も変更できません。作成フォームで 読み取り専用キー にチェックを入れます。読み取り専用キーは一覧に 読み取り専用 バッジが表示されます。スコープ機能が存在する前に作成されたキーはフルアクセスのままです。

キーのフォーマット

API キーは bws_ プレフィックスに 32 文字の 16 進文字列が続きます。

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

リクエストでの API キーの使用

すべての API リクエストの X-Api-Key ヘッダーに API キーを含めます。

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

API 認証の詳細は 認証 ページを参照してください。

プラン別のキー上限

作成できる API キーの数はプランによって異なります。

プラン	API キー上限
Free	1
Starter ($9/月)	5
Pro ($29/月)	20

キーの削除

1. API キー ページを開きます。
2. 削除したいキーを見つけます。
3. 削除 をクリックします。
4. 削除を確定します。

削除すると、キーは即座に動作しなくなります。そのキーを使用している任意のアプリケーションは認証エラーを受け取ります。