# APIキー管理 ヘルプ ## 概要 APIキー管理では、外部開発者向けのAPIキーを作成・管理できます。APIキーを使用することで、外部アプリケーションからUnlockOS APIにアクセスできます。 ## 主な機能 - APIキーの作成 - APIキーの一覧表示 - APIキーの有効化/無効化 - APIキーの削除 --- ## APIキー一覧 ### 表示項目 | 項目 | 説明 | |-----|------| | 名前 | APIキーの識別名 | | キー | キープレフィックス（マスク表示） | | スコープ | APIキーに付与された権限範囲 | | ステータス | 有効/無効 | | 最終使用日 | 最後に使用された日時 | | アクション | 編集・削除ボタン | ### ステータス | ステータス | 説明 | |----------|------| | 有効 | APIキーが使用可能な状態 | | 無効 | APIキーが一時的に使用不可な状態 | --- ## APIキーの作成 ### 入力項目 | 項目 | 説明 | 必須 | |-----|------|------| | 名前 | APIキーの識別名 | はい | | 説明 | APIキーの用途の説明 | いいえ | | テストモード | テスト環境用のキーかどうか | いいえ | | スコープ | APIキーに付与する権限 | はい | ### スコープ（権限範囲） スコープはカテゴリごとにグループ化されています。必要な権限のみを選択してください。 例： - チェックイン関連（読み取り、作成、更新） - プラン関連（読み取り、作成、更新） - 施設関連（読み取り） --- ## ボタン | ボタン | 説明 | |-------|------| | 新規作成 | 新しいAPIキーを作成します | | コピー | APIキーをクリップボードにコピーします | | 有効化/無効化 | APIキーのステータスを切り替えます | | 削除 | APIキーを削除します | --- ## セキュリティに関する注意 ### APIキーの取り扱い - **APIキーは作成時のみ表示されます**。作成後は再表示できないため、必ずその場でコピーしてください。 - APIキーは秘密情報として扱い、公開リポジトリにコミットしないでください。 - 不要になったAPIキーは速やかに削除してください。 ### テストモード - テストモード用のAPIキーは、テスト環境でのみ使用してください。 - 本番環境のデータには影響しません。 --- ## よくある質問 ### Q: APIキーを紛失した場合はどうすればいいですか？ A: 新しいAPIキーを作成し、古いAPIキーを削除してください。 ### Q: APIキーの使用回数に制限はありますか？ A: はい、レート制限があります。制限値はキー作成時に表示されます。 ### Q: 複数のAPIキーを作成できますか？ A: はい、用途ごとに複数のAPIキーを作成することを推奨します。 ### Q: APIキーのスコープを後から変更できますか？ A: いいえ、スコープを変更するには新しいAPIキーを作成する必要があります。 --- ## 関連ページ - Unlock Lab - 監査ログ