API Keys

注記

いずれも、Client-Server または Server-Side の実装についての手順です。UID2 の実装が Client-Side であるか、一般に公開される場合は、異なる値を設定する必要があります。詳細は、Client-Side Integration を参照してください。

UID2 Portal の API Keys ページでは、UID2 アカウントの API Key を管理するためのすべての操作を実行できます:

• Adding an API Key
• Modifying an API Key
• Deleting an API Key
• Rotating an API Key

Overview

API Key とクライアント シークレットを使用すると、UID2 Operator Service に接続して API エンドポイントを呼び出すことができます。これらの値は、サービスに対してあなたを識別します。

important

UID2 Portal で API Key を追加するときは、キーとそれに対応するシークレットを安全に保存し、これらの値が漏洩しないようにするために必要な措置をすべて講じる必要があります。詳細は、API Key and Client Secret を参照してください。

各 API Keyは、1 年ごとにローテーションすることを勧めます。

API Key を追加するときには、次のいずれかの権限を割り当てることができます:

• Mapper
• Generator
• Sharer
• Bidder

詳細は API Permissions を参照してください。

Adding an API Key

API Key を追加するには、次の手順を実行します:

1. UID2 Portal アカウントにログインします。

2. API Keys ページに移動し、Add API Key をクリックします。

3. Add API Key ページで、新しいキーの名前を指定します。

4. API Permissions セクションで、キーに割り当てる権限を 1 つ以上選択します。

   必要な権限のみを選択してください。たとえば、パブリッシャーの場合は Generator ロールを選択します。詳細は API Permissions を参照してください。

   注記

   選択可能な権限が表示されない場合は、UID2 連絡先に問い合わせてください。

5. Add API Key をクリックします。

   API Key (Your API Key Name) Credentials ページに API Key とシークレットが表示されます。

6. 各フィールドで、値をコピーするために (コピーアイコン) をクリックします。シークレットとキーの値を安全な場所に保存し、共有しないでください。

   ウィンドウを閉じると、これらの値は保存されず、利用できなくなります。失った場合は、新しいキーを追加する必要があります。

7. 完了したら、Close をクリックします。

8. リマインダープロンプトで、まだ値を保存していない場合は戻ることができます。値を保存していない場合は、Cancel をクリックして戻るか、Close をクリックして確認します。

   API Keys ページには、新しいキーが名前、キー ID、権限、および作成日付とともに表示されます。

Modifying an API Key

API Key を追加した後は、次の情報を編集できます:

• API key name
• Permission assignments

API Key を変更するには、次の手順を実行します:

1. UID2 Portal で API Keys ページに移動します。
2. リストでキーを見つけます。
3. アクション列で (編集アイコン) をクリックします。
4. 情報を更新し、Save Key をクリックします。

Deleting an API Key

Key が漏洩した場合、その Key を削除する必要があります。

警告

アクティブな Key を削除する前に、実装が新しい Key で更新されていることを確認してください。Key を削除すると、その Key を使用するすべての API トラフィックが拒否されます。

API Key を削除するには、次の手順を実行します:

1. UID2 Portal で API Keys ページに移動します。

2. リストでキーを見つけ、アクション列で (削除アイコン) をクリックします。

3. 確認メッセージで、削除を確認するために API Key を入力します。表示からコピーして貼り付けることができます。

4. Delete Key をクリックします。

   キーは表示から削除され、無効になります。

Rotating an API Key

API Key をローテーションすることを勧めます。API Key をローテーションするには、次の手順を実行します:

1. UID2 Portal で API Keys ページに移動します。
2. リストでローテーションする Key を見つけます。
3. ローテーションする Key と同じ権限を持つ新しい Key を追加します。詳細は Adding an API Key を参照してください。
4. UID2 の実装を更新して、ローテーションする Key の代わりに新しい Key を使用するようにします。
5. 新しい Key が問題なく使用されていることを確認します。たとえば、サービスに対する劣化や API Key の使用に関連するエラーログがないことを確認します。
6. 古い Key を削除します。詳細は Deleting an API Key を参照してください。

Security Recommendations for API Keys

セキュリティのベストプラクティスとして、異なる役割に対して異なるキーを持つことが推奨されます。

追加のセキュリティに関する推奨事項については、API Key and Client Secret のセキュリティ を参照してください。