認証

badges.ninja へのすべての API リクエストには認証が必要です。このページでは、リクエストを認証する方法を説明します。

ベース URL

https://api.badges.ninja

すべての API エンドポイントは、このベース URL からの相対パスです。

API キー認証

主な認証方法は、X-Api-Key ヘッダーで API キーを渡す方法です。

API キーの取得

ダッシュボードから:

badges.ninja にサインインします。
サイドバーの API Keys に移動します。
Create API Key をクリックします。
キーをコピーします（表示されるのは一度だけです）。

API から:

API キーは、Cognito 認証フローで取得した JWT トークンを使って API 経由で管理することもできます。最も簡単な方法はダッシュボードを使うことです。

API キーの使用方法

すべてのリクエストに X-Api-Key ヘッダーを含めてください。

bash

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

API キーの形式

キーには bws_ プレフィックスが付きます。

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

リクエスト形式

GET リクエストでは、パラメータをクエリ文字列として渡します
POST および PUT リクエストでは、parameters オブジェクトを含む JSON ボディを送信します
すべてのレスポンスは Content-Type: application/json の JSON を返します

POST/PUT リクエストの構造

json

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

リクエストの例

bash

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

レスポンスの例

json

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

パブリックエンドポイント

一部のエンドポイントは認証を必要としません。これらは /certify-badge/ 配下の公開検証エンドポイントで、誰でもバッジのクレデンシャルを検証できます。

認証 ​

ベース URL ​

API キー認証 ​

API キーの取得 ​

API キーの使用方法 ​

API キーの形式 ​

リクエスト形式 ​

POST/PUT リクエストの構造 ​

リクエストの例 ​

レスポンスの例 ​

パブリックエンドポイント ​

認証