API連携ガイド

APIキーの作成

AIアセスAPIを利用するには、APIキーが必要です。開発者ポータルから作成してください：

  1. AIアセスアカウントにサインインします。
  2. 開発者 > APIキーに移動します。
  3. 「APIキーを作成」をクリックします。
  4. キーの名前を入力します（例：「本番連携用」）。
  5. 必要なスコープを選択します。
  6. 「作成」をクリックします。

APIキーは作成時に1回のみ表示されます。安全にコピーして保管してください。紛失した場合は新しいキーを作成する必要があります。

スコープ

APIキーにはアクセスできるデータを制御するスコープがあります：

  • read:public — 公開ベンダーレジストリへのアクセス。ベンダー一覧、スコア、評価結果、証跡サマリーを取得できます。
  • read:org — ポリシー判定を含む組織のベンダーデータへのアクセス。組織スコープでAPIキーを作成する必要があります。

認証方法

すべてのリクエストに以下のいずれかの方法でAPIキーを含めてください：

方法1：Authorizationヘッダー（推奨）

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://ai-assess.voltanetworks.jp/api/v1/dev/public/products

方法2：X-API-Keyヘッダー

curl -H "X-API-Key: YOUR_API_KEY" \
  https://ai-assess.voltanetworks.jp/api/v1/dev/public/products

リクエスト例

ベンダー一覧の取得：

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://ai-assess.voltanetworks.jp/api/v1/dev/public/products?limit=20&offset=0"

スラッグで特定ベンダーを取得：

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://ai-assess.voltanetworks.jp/api/v1/dev/public/products/anthropic"

すべてのレスポンスは以下の形式です：

{
  "ok": true,
  "data": { ... },
  "meta": { "request_id": "uuid", "timestamp": "..." }
}

レート制限

APIリクエストはAPIキーごとにレート制限されます：

  • デフォルト：APIキーあたり毎分60リクエスト。
  • レート制限時、APIはHTTP 429 Too Many Requestsを返します。
  • レスポンスにはリトライ可能なタイミングを示すRetry-Afterヘッダーが含まれます。

より高い制限が必要な場合は、ユースケースについてお問い合わせください。

API連携ガイド — AIアセス