APIキーの生成
Orizmプラットフォームでは、異なる目的に応じて複数種類のAPIキーを使い分けます。このドキュメントでは、APIキーの役割と使い方について説明します。
APIキーの種類
Orizmプラットフォームには以下の3種類の主要なAPIキーがあります：
- Developer API Key - CMS SDKのCLIを使用するための開発者向けキー
- Management API Key - バックエンドでシステムとして認証するためのキー
- Consumer API Key - フロントエンドからコンテンツを取得するためのキー
それぞれのキーについて詳しく見ていきましょう。
Developer API Key
Developer API Keyは、CMS SDK CLIを使用して開発作業を行うための認証キーです。
主な用途
CMS SDK CLIでOrizmのAPIをコールするために必要です。例えば、Orizmプロジェクトにスキーマ定義を適用するために使用します。
取得方法
- コンソールでプロジェクトを選択
- 「Settings」 タブを選択
- サイドバーから 「API Keys」 > 「Developer Keys」 を選択
- 説明文を入力して 「Generate」 ボタンをクリック
APIキーの設定方法は CMS SDK CLI を参照してください。
Management API Key
Management API Keyは、バックエンドからシステム名義でOrizmのAPIをコールするためのキーです。
主な用途
Webhookを使った処理やデータ移行処理のようなユーザーセッションが無い処理
取得方法
- コンソールでプロジェクトを選択
- 「Settings」 タブを選択
- サイドバーから 「API Keys」 > 「Management Keys」 を選択
- 説明文を入力して 「Generate」 ボタンをクリック
権限設定
Management API Keyはグループとロールを持ちます。キーの生成後に権限を設定できます：
- キーの一覧から対象キーの 「permissions」 ボタンをクリック
- 「Management API Key Permissions」モーダルで「+」ボタンをクリックし、新しいRoleとGroupの入力エリアに任意の値を入力します。
- 「Save changes」 ボタンをクリックして保存します。
使い方はCMS SDKの クライアントのセットアップ を参照してください。
Management API Key がクライアントサイドに漏洩しないように注意してください。漏洩した場合、API Keyが持つ権限でAPIをコールされる可能性があります。フロントエンドのコードにはManagement API Keyを含めないでください。
Consumer API Key
Consumer API Keyは、Consumer SDKを使ってコンテンツへアクセスするために使用するAPIキーです。
主な用途
Consumer SDKを使ってコンテンツにアクセスするために使用します。
特徴
コンテンツへの読み取りアクセス
取得方法
- コンソールでプロジェクトを選択
- 「Settings」 タブを選択
- サイドバーから 「API Keys」 > 「Consumer Keys」 を選択
- 説明文を入力し、必要に応じて 「Allow reading draft content with this key」 にチェック
- 「Generate」 ボタンをクリック
使い方はConsumer SDKの クライアントのセットアップ を参照してください。
下書きコンテンツへのアクセス権を持つConsumer API Keyがクライアントサイドに漏洩すると、不特定多数のユーザーが下書きコンテンツにアクセス可能になるリスクがあります。Consumer API Keyはサーバーサイドのみで使用することを推奨します。
注意事項
- APIキーは公開リポジトリにコミットしないように注意してください。APIキーは機密情報です。公開リポジトリにコミットすると悪意のあるユーザーによって悪用される可能性があります。
- もしもAPIキーが漏洩した場合は、新しいAPIキーを生成し、漏洩したAPIキーを削除してください。