Overview

APIキーは通常、認証または認可のメカニズムとして使用されます。それらは、APIリソースにアクセスするユーザーまたはアプリケーションに関連付けられた一意の識別子です。

APIキーは、APIプロバイダーがリソースへのアクセスを追跡および制御する方法として機能します。彼らはAPIアクセスのセキュリティとアカウンタビリティを確保し、プロバイダーが使用状況を効果的に管理および監視できるようにします。

MoEngageにデータを送信するには、その特定のデータに対するワークスペースIDとAPIキーを使用できます。ユーザーデータを送信するために使用されるAPIキーは、イベントを送信するために使用されるAPIキーとは異なります。キーが再生成されるたびに、古いキーは即座に無効になり、新しいキーが機能するまでには時間がかかるため、ダウンタイムが発生する可能性があります。ソリューションとして、MoEngageは複数のAPIキーを提供しており、これにより次のことが可能になります：

• 既存のキーがまだ利用可能な間に新しいキーを生成する : マルチキーサポートにより、既存のキーは新しいキーが機能するようになるまで使用できます。これにより、セキュリティ目的でキーをローテーションし、ダウンタイムを回避できます。内部チームが新しいキーを作成し、それをシステムに統合するのに時間がかかるシナリオを考えてみてください。古いキーがまだ機能しているため、チームは新しいキーをシステムに統合する時間を持つことができます。新しいキーを統合した後、古いキーを非推奨にすることができます。これにより、MoEngageにデータを送信する際のダウンタイムを回避できます。
• 異なるチームには異なるキーを使用する : さまざまなベンダーと協力しているエンタープライズ顧客のシナリオを考えてみてください。このエンタープライズ顧客は、ビジネスユースケースを満たすために、1つのベンダーとキーを共有することができ、これはセキュリティ上の理由から他のベンダーが同じユースケースを満たすことを制限します。この機能を使用することで、すべてのベンダーは異なるキーを使用して同じユースケースを満たすことができます。さらに、エンタープライズ顧客として、機能に基づいて異なる内部チームに異なるキーを使用することができます。

キーを作成する

キーを作成するには、次の手順を実行します：

1. MoEngage ダッシュボードの左側のナビゲーションメニューで、 設定 > アカウント > API キー に進んでください。
2. クリック + 新しいキーを作成 。
   
3. 新しい キーを作成 ページで、次の詳細を入力します：
   1. キー名 ボックス に、 キーの識別を容易にするための名前を入力します。
   2. アクセス用のAPIを選択 チェックボックスリストで、このキーを使用してアクセスしたいAPIを選択します。
      
4. クリックして 保存 します。保存後、このキーは アクティブ APIキー の下にリストされます。

   info	情報 APIアクセス は、このキーを使用してすべてのリストされたAPIにアクセスできる場合は フル です。それ以外の場合は 部分的 です。

   
5. アーカイブされたキーの一覧を表示するには、 アーカイブされたキーを表示 をクリックしてください。
6. On the API Keys page , clicking for each API key displays the following options:
   
   

   Option	Description
   View key details	Click this option to view the key details. You can access the edit key and regenerate key options from the View key details page.
   Regenerate key	Click this option to regenerate a new key. Note : The old key expires immediately after regenerating. To avoid errors, replace the old key with the regenerated key.
   Edit key details	Click this option to edit the key name or access to your APIs.
   Archive key	Click this option to archive your keys. After archiving them once, you cannot unarchive keys. Note : A maximum of 10 archived keys is maintained under the archived key list.

監査ログ

管理者は、MoEngageダッシュボードで実行されたさまざまなアクションを理解するために監査ログを使用します。同様に、監査ログはAPIキーに関連するアクションも一覧表示します。これにより、管理者はAPIキーに関連するどのアクションを誰が実行したかを把握できます。以下のアクションは 監査ログ でサポートされています:

• 監査ログを チーム 、 アクション 、 アクター 、および 日時範囲 に基づいてフィルタリングするには、 をクリックしてください。
• 取得したい監査ログの 検索ログによる 検索バーに値を入力してください。
• クリックして 監査ログをエクスポート し、監査ログレポートをメールで受け取ります。メールからレポートをダウンロードできます。

APIキーに関連するすべてのアクションについては、 監査ログ の エンティティ 列に APIキー が表示されます。APIキーに関連する以下のアクションを監査ログの アクション 列で表示できます:

• 作成 は、APIキーが正常に作成されたときに表示されます。
• 更新 は次の場合に表示されます:
  
  • キー名が更新されたとき。
  • キーのAPIアクセスが更新されたとき。
  • キーが再生成されたとき。
• 削除 は、キーがアーカイブされると表示されます。