APIキー設定
APIキーは、外部システムがABC User Feedbackと安全に統合できるようにする認証手段です。このドキュメントでは、APIキーの作成から管理、セキュリティ維持まで、画面中心で説明します。
APIキーの概要
APIキーの役割
APIキーは次の目的で使用されます：
- 外部システム認証: ウェブサイト、モバイルアプリからフィードバック送信
- 自動化統合: バッチジョブ、スクリプトによるデータ収集
- サードパーティツール接続: 分析ツール、モニタリングシステム統合
- セキュリティ制御: プロジェクト別の独立したアクセス権限管理
セキュリティ特徴
- プロジェクト別独立性: 各プロジェクトごとに別々のキー発行
- ステータス管理: Active/Inactiveステータスで即座に制御可能
APIキーの作成
アクセス方法
- 上部メニューでSettingsをクリック
- 左メニューからAPIキー管理を選択
キー作成プロセス
1. 作成ボタンをクリック
APIキー管理画面で右上のCreate API Keyボタンをクリックします。
2. 自動生成と表示
ボタンをクリックするとすぐに新しいAPIキーが自動生成され、ポップアップで表示されます。
ポップアップ構成要素：
- APIキー値: 完全なキー文字列を表示
- Copyボタン: クリップボードに即座にコピー
APIキーリスト管理
キーリスト画面構成
作成されたAPIキーはテーブル形式で管理されます。
テーブル列情報
| 列 | 説明 | 表示形式 |
|---|---|---|
| APIキー | 生成されたキー値 | AbcdEfgh... |
| Status | 現在の有効化ステータス | Active / Inactive |
| Created | キー作成日時 | 2024-03-15 14:30 |
| Actions | 管理アクションボタン | ステータス変更、削除ボタン |
キー識別方法
完全なキー値を再度確認できないため、次の方法でキーを区別します：
- 作成時刻: いつ作成されたキーか確認
- 使用目的メモ: 別途キーの用途を記録しておく
APIキーステータス管理
Active / Inactiveの切り替え
各APIキーは即座に有効化/無効化できます。
ステータス別の意味
| ステータス | 説明 | API呼び出し結果 |
|---|---|---|
| Active | 実際のAPI呼び出しに使用可能 | 正常処理 |
| Inactive | 呼び出しブロック状態 | 401 Unauthorized |
ステータス変更方法
- APIキーリストでStatus列のトグルスイッチをクリックします
- ステータスが即座に変更され、画面に反映されます
- そのキーを使用する外部システムで即座に影響を受けます
APIキーの削除
削除タイミング
次の場合、APIキーを削除する必要があります：
- キー公開: 誤ってキーが公開された場合
- プロジェクト終了: 該当プロジェクトの使用終了
- セキュリティポリシー: 定期的なキー交換ポリシーに従って
- 未使用キー: 使用しなくなったキーの整理
削除方法
1. 削除ボタンをクリック
キーリストで削除したいキーのActions列の削除ボタンをクリックします。
2. 削除確認
確認ダイアログで削除を最終承認します。
3. 削除完了
Deleteボタンをクリックすると、キーが即座に削除され、リストから削除されます。