インテグレーションをPendoに接続する場合、またはパブリックAPIエンドポイントを使用する場合、Pendoでインテグレーションキーを生成します。すべてのインテグレーションにインテグレーションキーが必要とは限りません。
このキーは、Pendoのインストールスクリプトに表示されるアプリケーションキー(通称「スニペット」)とは異なります。インストールスクリプトのアプリケーションキーは、Pendoをアプリケーションに接続するものです。詳細については、インストールスクリプトを使用したPendoの実装に関する開発者ガイドを参照してください。
Pendo Feedbackのインテグレーションには、別のキーが必要です。詳細と手順については、Pendo Feedback APIキーをご覧ください。
権限
インテグレーション鍵の使用および作成には以下の権限が適用されます:
- 誰でもインテグレーションキーを使えます。特定のユーザーアカウントや権限レベルに紐付けられていないため、管理者以外のユーザーでも、問題なくデータへのアクセスやインテグレーションとの接続に使用できます。キーを使用するとサブスクリプション内のすべてのアプリケーションにプログラムからアクセスできるため、パスワードと同様に扱い、厳重に管理します。
- キーを作成または管理できるのは Pendo 管理者のみです。統合キーの作成、閲覧、管理にはPendoのサブスクリプション管理者権限と統合キーのアクセスが必要です。
サブスクリプションの管理者は、この機能を有効にできます。管理者の方で、この機能が表示されない場合は、Pendoのアカウント担当者にお問い合わせください。
インテグレーションキーの作成
- Pendoの右上で、[設定(Settings)]>[インテグレーション(Integrations)]>[インテグレーションキー(Integration Keys)]の順に選択します。
- [+インテグレーションキーを追加(+ Add Integration Key)]を選択します。
- インテグレーションキーにわかりやすい説明を入力します。
-
[作成(Create)]を選択します。
- 紛失または削除されたインテグレーションキーを取得することはできないため、作成時にPendoの外部で新しいキーを安全に取得して保管します。
インテグレーションキーの回復
インテグレーションキーは作成時のみ表示され、UIには表示されません。紛失したインテグレーションキーは復元できません。既存のキーの値が見つからない場合は、新しいキーを作成する必要があります。Pendoでは、生成されるキーの数に制限はありません。
インテグレーションキーを使用したサブスクリプションへのアクセス
インテグレーションキーは、サブスクリプション内の特定のアプリケーションに関連付けられていません。インテグレーションキーを使うと、Pendoサブスクリプション内のすべてのアプリケーションにアクセスできます。Pendoで複数のアプリケーションを使用している場合は、特定のアプリケーションまたはすべてのアプリケーションからデータをリクエストする方法について、APIドキュメントのマルチアプリセクションを確認してください。
また、インテグレーションキーは特定の環境に関連付けられていません。Pendoサブスクリプションには、Pendoがインストールされているすべての環境のデータが含まれています。ただし、除外リストを使用すると、イベントを除外できます。これには、本番環境以外のドメインからのイベントの除外も含まれます。APIリクエストで、任意のブロックリストパラメータを使用して、除外リストに含まれるイベントをレスポンスに含めるかどうかを指定できます。