Workvivo APIベアラートークンの作成
Workvivo APIへのすべてのリクエストは、認証ヘッダーにベアラートークンを含める必要があります。この記事では、アプリの作成方法、必要なスコープの割り当て方法、およびベアラートークンの生成方法について説明します。
- Workvivoでアプリを作成する
- インテグレーションに必要な権限とスコープを割り当てる
- ベアラートークンを生成し、安全に保管する
必要条件
デバイス：デスクトップ
役割：開発者
利用可否：APIアクセスはWorkvivoサポートによる有効化が必要です。
- 組織のAPIアクセスをリクエストするには、Workvivoサポートにお問い合わせください。
- APIアクセスが有効化されたら、アカウント管理者がユーザーに開発者の役割を付与する必要があります。詳細は「Workvivoでの役割の付与」を参照してください。
開発者の役割を持つユーザーは、管理メニューからAPIキーとJWT設定にアクセスできます。そこから、アプリの作成、インテグレーションスコープの管理、ベアラートークンの生成を行うことができます。
アプリを作成してトークンを生成する
1. 「APIキーとJWT設定」を開く
[Administration（管理）] を開き、[API Keys and JWT Settings（APIキーとJWT設定）] を選択します。
2. アプリを追加する
「新しいアプリを追加」を選択してください。
3. アプリに名前を付けてスコープを割り当てる
アプリにわかりやすい名前を入力し、インテグレーションに必要な権限を選択します。各エンドポイントに必要なスコープを確認するには、APIドキュメントをご覧ください。例えば、Teams APIを使用するインテグレーションには、該当するTeamsの読み取りまたは書き込みスコープが必要です。
ヒント：必要に応じて、後でアプリのスコープを更新できます。
4. アプリのキーを管理する
アプリを作成した後、「キー管理」を選択します。
5. ベアラートークンを生成する
[Add New Key（新しいキーを追加）] を選択し、キーの名前を入力します。Workvivoがベアラートークンを生成して表示します。
重要：ウィンドウを閉じる前に、トークンをコピーして大切に保管してください。ウィンドウが閉じた後はトークンを再度取得できません。
トークンが漏えいした、または漏えいした可能性がある場合は、直ちにそのキーを削除し、新しいトークンを生成してください。
追加情報
- 利用可能なエンドポイントと必要なスコープについては、Workvivo開発者ドキュメントを参照してください。
- すべてのWorkvivoアカウントでAPIアクセスが有効になっているわけではありません。アクセスが必要な場合はWorkvivoサポートに連絡してください。