API Keys
これらは、Client-Server または Server-Side の実装についての手順です。UID2 の実装が Client-Side であるか、一般に公開される場合は、異なる値を設定する必要があります。詳細は、Client-Side Integration を参照してください。
UID2 Portal の API Keys ページでは、UID2 アカウントの API Key を管理するためのすべての操作を実行できます:
Overview
API Key と Client Secret を使用すると、UID2 Operator Service に接続して、直接または UID2 SDK を介して API エンドポイントを呼び出すことができます。これらの値は、サービスに対してあなたを識別します。
UID2 Portal で API Key を追加するときは、キーとそれに対応するシークレットを安全に保存し、これらの値が漏洩しないようにするために必要な措置をすべて講じる必要があります。詳細は、API Key と Client Secret を参照してください。
各 API Key は、1 年ごとにローテーションすることを推奨します。
API Key を追加するときには、次のいずれかの権限を割り当てることができます:
- Mapper
- Generator
- Sharer
- Bidder
詳細は API Permissions を参照してください。
Adding an API Key
API Key を追加するには、次の手順を実行します:
-
UID2 Portal アカウントにログインします。
-
API Keys ページに移動し、Add API Key をクリックします。
-
Add API Key ページで、新しいキーの名前を指定します。
-
API Permissions セクションで、キーに割り当てる権限を 1 つ以上選択します。
必要な権限のみを選択してください。たとえば、パブリッシャーの場合は Generator ロールを選択します。詳細は API Permissions を参照してください。
注記選択可能な権限が表示されない場合は、UID2 の担当者に問い合わせてください。
-
Add API Key をクリックします。
API Key (Your API Key Name) Credentials ページに API Key とシークレットが表示されます。
-
各フィールドで、値をコピーするために
(Copy アイコン) をクリックします。シークレットとキーの値を安全な場所に保存し、共有しないでください。ウィンドウを閉じると、これらの値は保存されず、利用できなくなります。失った場合は、新しいキーを追加する必要があります。
-
完了したら、Close をクリックします。
-
リマインダープロンプトで、まだ値を保存していない場合は戻ることができます。値を保存していない場合は、Cancel をクリックして戻るか、Close をクリックして確認します。
API Keys ページには、新しいキーが名前、キー ID、権限、および作成日付とともに表示されます。
Modifying an API Key
API Key を追加した後は、次の情報を編集できます:
- API Key 名
- 権限の割り当て
API Key を変更するには、次の手順を実行します:
- UID2 Portal で API Keys ページに移動します。
- リストでキーを見つけます。
- アクション列で
(Edit アイコン) をクリックします。 - 情報を更新し、Save Key をクリックします。
Deleting an API Key
キーが漏洩した場合、そのキーを削除する必要があります。
アクティブなキーを削除する前に、実装が新しいキーで更新されていることを確認してください。キーを削除すると、そのキーを使用するすべての API トラフィックが拒否されます。
API Key を削除するには、次の手順を実行します:
-
UID2 Portal で API Keys ページに移動します。
-
リストでキーを見つけ、アクション列で
(Delete アイコン) をクリックします。 -
確認メッセージで、削除を確認するために API Key を入力します。表示からコピーして貼り付けることができます。
-
Delete Key をクリックします。
キーは表示から削除され、無効になります。
Rotating an API Key
API Key をローテーションすることを推奨します。API Key をローテーションするには、次の手順を実行します:
- UID2 Portal で API Keys ページに移動します。
- リストでローテーションするキーを見つけます。
- ローテーションするキーと同じ権限を持つ新しいキーを追加します。詳細は Adding an API Key を参照してください。
- UID2 の実装を更新して、ローテーションするキーの代わりに新しいキーを使用するようにします。
- 新しいキーが問題なく使用されていることを確認します。たとえば、サービスに対する劣化や API Key の使用に関連するエラーログがないことを確認します。
- 古いキーを削除します。詳細は Deleting an API Key を参照してください。
Security Recommendations for API Keys
セキュリティのベストプラクティスとして、異なる役割に対して異なるキーを持つことが推奨されます。
追加のセキュリティに関する推奨事項は、API Key と Client Secret のセキュリティ を参照してください。