認証
外部 API へのリクエストは、すべて組織単位の APIキーで認証します。
APIキーを発行する
Organization Admin(組織管理者)の権限でイマーシブトレーニングプラットフォームにサインインします。
組織設定の「APIキー」タブを開きます。
「APIキーを作成」をクリックします。
キーの名前と説明を入力します。
発行されたキーをコピーし、安全な場所に保管します。
画面での管理方法は「APIキーの管理」もご覧ください。
APIキーを使う
すべてのリクエストで、Authorization ヘッダーに APIキーを Bearer トークンとして付けます。
Authorization: Bearer your-api-key-hereAPIキーは組織単位です。リクエストは、キーを所有する組織に自動的にひも付けられます。
ベースパス
{organizationID} を、お客様の組織 ID に置き換えます。組織 ID は org_abc123 のような識別子で、UUID ではありません。
コード例
他のページのコード例にある BASE_URL・headers・API_KEY は、ここで定義したものを指します。
エラーレスポンス
401 Unauthorized
APIキーが指定されていない、正しくない、またはこの組織のものではない場合に返されます。ボディは message ではなく error キーです。
よくある原因
Authorization ヘッダーが無い
リクエストに Authorization: Bearer your-api-key-here を付ける
APIキーが正しくない
発行したキーと一致しているか確認する
APIキーが削除されている
管理画面で新しいキーを発行する
URL の組織 ID が違う
{organizationID}(例: org_abc123。UUID ではない)が、キーを所有する組織のものか確認する
キー管理のベストプラクティス
入れ替えは「発行してから削除」の順で: 新しいキーを発行し、連携システムを切り替えてから、古いキーを削除します。
環境変数を使う: APIキーをソースコードに直接書かないでください。
利用状況を確認する: 連携システムと APIキーの使われ方を定期的に見直し、想定外の利用がないか確認します。
無効にするには削除する: キーを削除すると受け付けられなくなります。キーに有効期限は無いため、使わなくなったキーは削除してください。
最終更新
