MID Web サーバー API キー認証を構成する

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：2分

API キー認証を使用して、クライアントから MID Web サーバー拡張への着信要求を認証します。API 認証は、要求を認証するための安全で簡単な方法です。MID Web サーバー API キーを作成または変更できます。

始める前に

MID Web サーバー拡張の設定の説明に従って、API キー認証を使用する MID Web サーバー拡張を作成します。拡張の [認証タイプ] フィールドで [API キー] を選択していることを確認してください。

必要なロール：event_mgmt_admin

デフォルトでは、1 つのインスタンスに作成できる API キーの最大数は 10 です。この数を変更するには、[システムのプロパティ] ページの mid.webserver.max.api.keys プロパティ値を変更します。

[ドメインセパレーション] が有効なときにグローバルドメインで作業している場合、API キーはドメインに関係なくすべての拡張で使用できます。特定のドメインで作業している場合は、そのドメイン、その親ドメイン、、およびグローバルドメインの拡張に対して API キーを使用できます。

指定した日付に期限切れになるように API キーを設定できます。

API キー認証を使用して新しい拡張を作成する (または API キー認証を使用するように既存の拡張を更新する) と、システムは拡張に利用可能な API キーを確認します。利用可能な API キーがない場合は、API キーを作成します。

新しい API キーを作成するか、既存の API キーを変更します。

新しい API キーを作成するには、次の手順に従います。

[MID Web サーバー API キー] フォームのフィールドに入力します。

表 : 1. MID Web サーバーの [API キー] フォーム
フィールド	説明
名前	API キーの名前。
有効	API キーを有効にするためのオプション。
認証キー	認証キーの、読み取り専用のエンコード値。キーを設定するまで値は表示されません。
有効期限	API キーの有効期限を設定するためのオプション。期限切れ、非アクティブ化、または削除された API キーは、Web サーバー拡張では受け入れられません。