APIトークンは、外部のアプリケーションやプログラムから、ゲンバルジャーの管理システムにアクセスするための認証キーです。管理画面にログインして操作する代わりに、プログラムからコンテンツの登録・取得やスケジュールの設定などを行う場合に使います。
どんなときに使うか
- 社内のシステムから、表示するコンテンツを自動で登録・更新したいとき
- 登録済みのコンテンツやスケジュールの情報を、プログラムで取得したいとき
メディアの登録やプレイリスト・スケジュールの設定といった通常の運用は、管理画面だけで行えます。APIトークンはプログラムの開発を伴う使い方のための機能で、使わなくてもゲンバルジャーは利用できます。
生成するときに決める項目
管理画面の「アカウント設定」にある「APIトークン」で「トークンを生成する」をクリックし、次の項目を設定します。
- トークン名：用途が分かる名前を入力します。
- グローバル管理者：オンにすると、請求を除くすべての項目に無制限にアクセスできます。
- 請求アクセス：オンにすると、請求書、サブスクリプションの変更、支払い方法の変更にアクセスできます。
- ワークスペースへのアクセス：ワークスペースでトークンを使う場合に、カスタムロールを使ってアクセスを許可します。
画面の詳細はAPIトークンの設定をご覧ください。発行の場所はAPIトークンの発行方法、権限の考え方はAPIトークンの権限と有効期限で説明しています。
取り扱いの注意
APIトークンを持つ人やプログラムは、設定した権限の範囲で管理システムを操作できます。パスワードと同じように扱い、メールやチャットに貼り付けたり、プログラムの中にそのまま書いて共有したりしないでください。