API トークンを作成・無効化する
トークンでできること
トークンは、それを作成した本人として、作成した時点でアクティブだったチームの中で動作します。できることは、作成時に許可した範囲に限られます。次のいずれかを選びます。
- スクリーンとシーンを操作: スクリーン、コンテンツ、シーンの表示、スクリーンへのコンテンツの送信、シーンの開始と停止ができます。Bitfocus Companion で使う場合はこれを選びます。
- 読み取り専用: スクリーン、コンテンツ、シーンの表示のみで、それ以外はできません。
- フルアクセス（デザインの作成を含む）: 上記のすべてに加えて、デザインの作成ができます。
トークンを作成した人がチームへのアクセス権を失うと、そのトークンは使えなくなります。
トークンを作成する
- 設定 > 接続 を開きます。
- APIトークン の下で 新しいAPIトークン をクリックします。
- トークンに名前を付けます。たとえば会場名や、そのトークンを使うプログラムの名前です。
- アクセス権 で、トークンに許可する内容を選びます。
- トークンを作成 をクリックします。
- コピー をクリックし、トークンを安全な場所に保管します。たとえば、そのトークンを必要とするプログラムの中です。
- 完了 をクリックします。
トークンが表示されるのは 1回だけです。紛失した場合は、そのトークンを無効化して、新しく作成してください。
トークンは、作成時にアクティブだったチームで有効です。別のチームのスクリーンを操作する場合は、先にそのチームに切り替えて、別のトークンを作成してください。プログラムごとに別のトークンを使うと、ほかのプログラムを止めずに、1つだけ無効化できます。
初期状態では、オーナーと管理者がトークンを作成できます。これはロールによって決まります。ロールごとの設定は、チームの管理で変更できます。
トークン作成時のメール
トークンが作成されると、作成した本人とアカウントのオーナーにメールが届きます。メールには、どのトークンか、作成者、対象のチーム、作成日時、トークンでできることが書かれています。メールにトークンそのものは含まれません。心当たりのないトークンであれば、すぐに無効化してください。
トークンを確認する
APIトークン カードには、トークンごとに次の情報が表示されます。
- 名前とアクセスの種類
- トークンの末尾の四文字（トークンを見分けるためのものです）
- チーム
- 最後に使われた日時、または 未使用
オーナーには、アカウント内の全員のトークンが表示されます。それ以外の人には、自分のトークンだけが表示されます。
トークンを無効化する
- 設定 > 接続 を開きます。
- トークンの横にある 無効化 をクリックします。
- もう一度 無効化 をクリックして確定します。
そのトークンを使っているものはすべて、すぐに止まります。
有効期限があるトークン
一年間使われなかったトークンは、自動的に無効化されます。一度も使われていないトークンは、作成した日から数えます。再び必要になったら、新しいトークンを作成してください。
上限
アカウントで作成できるトークンの数には上限があります。上限に達すると、先にトークンを 1つ無効化するよう Screenbird から案内されます。
接続済みのアプリ
トークンではなく Screenbird のログインで接続したアプリは、同じページの専用カード 接続済みアプリ に表示されます。接続解除 をクリックすると、そのアプリを削除できます。
独自の接続を作る
Screenbird には公開 API があります。リクエストのたびに、トークンを Bearer トークンとして送信します。すべてのリクエストと、それぞれに必要な権限を含む API の完全な説明は、api.screenbird.app/v1/openapi.json にあります。