APIキーの管理

フォローする

APIキー

APIキー(権限 → APIキー)は、外部システムがGillieのAPIを呼び出すための認証情報です。各キーには固有の権限があり、その使用はチームや許可されたAPIに制限できます。

基本情報

  • 名前 — キーの説明的な名前(必須)。

署名検証

  • 検証用チェックサムを要求 — このスイッチがオンの場合、呼び出しにはキーのチェックサム(ハッシュ)を含める必要があります。運用環境での使用を推奨します。

キーの表示

キーが保存されると、以下が表示されます:

  • APIキー — 呼び出し時に送信する公開識別子。
  • 秘密鍵 — 最初の作成時にのみ表示されます。再表示できないため、すぐに安全な場所に保存してください。

許可されたチーム

  • すべてのチームを許可 — キーはすべてのチームにアクセス可能です。
  • スイッチがオフの場合は、リストから許可されたチームを選択してください。

許可されたAPI

許可されたAPIリストには、APIのパスやパターン(例:/api/v1/customers)を指定します。キーはこれらに一致するAPIのみ呼び出せます。

ロールグループと権限

キーにはユーザーと同様に権限を割り当てます:ロールグループとキーに付与するロールを選択してください。

追加機能

  • 監査履歴 — キーの変更履歴(権限 admin_apikeys_audit)。
  • 埋め込みテスト — 管理画面から直接キーの簡易テスト(保存後に表示)。
  • 削除 — キーを完全に削除します。

警告。 秘密鍵は一度だけ表示されます。キーを紛失または漏洩した場合は、古いキーを削除し新しいキーを作成してください。

権限

管理には権限 admin_apikeys が必要です。