PushEngage APIキーはサイトのAPIリクエストを認証するため、PushEngage APIを呼び出すものはすべてそれを使用します。サイト設定からキーを表示、コピー、再生成でき、各サイトには独自のキーがあります。このガイドでは、APIキーの見つけ方と安全なローテーション方法を説明します。
開始する前に
- 管理したいサイトへのアクセス権を持つPushEngageダッシュボードにサインインしている必要があります。
- キーをすぐに再生成すると、古いキーは置き換えられます。古いキーを使用している統合は、新しいキーで更新するまで機能しなくなるため、ローテーション直後に統合を更新する計画を立ててください。
- APIキーはサイト固有です。複数のサイトを管理している場合は、まず正しいサイトに切り替えてください。
APIキーの見つけ方
PushEngageダッシュボードで、サイト設定 » サイト詳細に移動し、APIキーセクションまでスクロールします。
最初のAPIキーを生成する
サイトにまだAPIキーがない場合は、新しいAPIキーを生成をクリックします。PushEngageがキーを作成し、「APIキーが正常に生成されました」と確認します。
APIキーをコピーする
キーが存在すると、安全のためマスクされて表示されます。コピーをクリックして完全なキーをクリップボードにコピーし、必要な場所に貼り付けます。キーは画面上では常にマスクされて表示されるため、読み取ろうとするのではなく、コピーを使用してください。
APIキーをローテーション（再生成）する
キーをローテーションすると新しいキーに置き換えられます。これは、キーが漏洩した可能性がある場合や、定期的なメンテナンスのために適切な手順です。
- APIキーセクションで、APIキーを再生成をクリックします。
- 確認プロンプトの「APIキーを再生成しますか？」で、はい、再生成しますをクリックします。
- PushEngageは新しいキーを発行し、生成されたことを確認します。
- 新しいキーをコピーし、古いキーを使用していたすべての統合を更新してください。
よくある質問
キーを再生成すると、統合は壊れますか？
はい、更新するまでです。キーを再生成した瞬間に古いキーは機能しなくなるため、それを使用しているアプリ、プラグイン、またはスクリプトは、新しいキーに置き換えるまで失敗します。すぐに統合を更新できるときにローテーションしてください。
APIキーはすべてのサイトで同じですか？
いいえ。各サイトには独自のAPIキーがあります。複数のサイトを管理している場合は、キーをコピーまたは再生成する前に、正しいサイトにいることを確認してください。
マスクされたキーしか表示できないのはなぜですか？
セキュリティのため、キーは画面上ではマスクされて表示されます。コピーボタンを使用して、完全なキーをクリップボードにコピーしてください。
APIキーをいつローテーションすべきですか？
キーが漏洩したと思われる場合、アクセス権を持つ人物が退職した場合、または定期的なセキュリティ対策として、定期的にローテーションしてください。毎回、新しいキーでインテグレーションを更新することを忘れないでください。
問題が発生した場合は、ここをクリックしてお気軽にお問い合わせください。サポートチームがお手伝いします。