API キー

概要

API キーを使用すると、セッション Cookie を使わずに API にアクセスできます。サーバー間通信や外部サービスとの連携に最適です。

API キーの作成

API キーは組織の設定画面、または API 経由で作成できます。

curl -X POST https://api.blueai.jp/api/v1/api-keys \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{"name":"My Integration"}'

API キーの使用

API キーはリクエストの Authorization ヘッダーに Bearer トークンとして含めます。

curl https://api.blueai.jp/api/v1/crm/deals \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx"

const res = await fetch("https://api.blueai.jp/api/v1/crm/deals", {
  headers: {
    Authorization: "Bearer sk_live_xxxxxxxxxxxxxxxxxxxx",
  },
});
const data = await res.json();

セキュリティ

API キーはパスワードと同様に機密情報です。以下のベストプラクティスに従ってください。

• API キーをクライアントサイドのコードに含めない
• 環境変数で管理し、ソースコードにハードコードしない
• 不要になったキーはすぐに無効化する
• キーごとに最小限の権限を設定する

API キーの無効化

API キーが漏洩した場合や不要になった場合は、すぐに無効化してください。無効化されたキーを使用したリクエストは即座に拒否されます。

curl -X DELETE https://api.blueai.jp/api/v1/api-keys/ak_123e4567e89b12d3a456426614174000 \
  -b cookies.txt