APIキー管理

APIキーの作成、表示、削除について説明します。

APIキーとは

APIキーは、外部のアプリケーションやWebサイトからコンテンツを取得するための認証情報です。

用途

• フロントエンドサイトからのコンテンツ取得
• 外部システムとの連携
• 自動化スクリプトからのアクセス

APIキー一覧

1. サービス画面で「APIキー」タブを選択
2. 発行済みのAPIキー一覧が表示される

表示項目

項目	説明
名前	APIキーの識別名
キープレフィックス	キーの先頭部分（セキュリティのため一部のみ表示）
作成者	キーを作成したユーザー
最終使用日	最後にAPIキーが使用された日時
作成日	キーを作成した日時

APIキーの作成

権限

APIキーの作成には Admin 権限が必要です。

1. APIキー一覧画面で「新規作成」をクリック
2. キーの名前を入力（用途が分かる名前を推奨）
3. 「作成」をクリック
4. 生成されたAPIキーが表示される

重要

APIキーは作成時に一度だけ表示されます。必ずコピーして安全な場所に保管してください。

命名例

• production-frontend
• staging-site
• mobile-app
• analytics-integration

APIキーの使用方法

APIリクエスト時に X-API-Key ヘッダーを設定します。

# エンドポイント名を指定してコンテンツを取得
curl -H "X-API-Key: YOUR_API_KEY" \
  https://your-domain/api/v1/news

endpoint について

{endpoint} にはエンドポイントのパス名（news, blog等）を指定します。 詳細は APIリファレンス を参照してください。

JavaScriptでの例

const response = await fetch('https://your-domain/api/v1/news', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});
const { contents } = await response.json();

APIキーの削除

1. 削除したいAPIキーの行で「削除」をクリック
2. 確認ダイアログで「削除する」を選択

注意

APIキーを削除すると、そのキーを使用しているアプリケーションは即座にアクセスできなくなります。

セキュリティのベストプラクティス

やるべきこと

• 用途ごとに別々のAPIキーを発行
• 定期的にキーをローテーション
• 不要になったキーは速やかに削除
• 環境変数でキーを管理（コードに直接書かない）

やってはいけないこと

• APIキーをGitリポジトリにコミット
• APIキーをクライアントサイドJSに直接埋め込む
• 複数の環境で同じキーを使い回す

必要な権限

操作	必要な権限
一覧表示	Admin
作成	Admin
削除	Admin

関連ページ

• 権限リファレンス