Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Link from '@docusaurus/Link';

# UID2 Endpoints: Summary

すべての UID2 エンドポイントでは、API リクエストの暗号化([POST /token/refresh](post-token-refresh.md) を除く) とレスポンスの復号化にクライアントシークレットが必要です。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。
すべての UID2 エンドポイントでは、API リクエストの暗号化([POST /token/refresh](post-token-refresh.md) を除く) とレスポンスの復号化に Client Secret が必要です。詳細といくつかのプログラミング言語でのコードの例は、[Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) を参照してください。

## UID2 Endpoints by Audience

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Server-Side 実装で UID2 エンドポイントへの認証を行うには、

- クライアントの [API Key](gs-credentials.md#api-key-and-client-secret)。API Key はベアラートークンとしてリクエストの Authorization ヘッダーに含めます。たとえば:<br/>
`Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk=`
- API リクエストを暗号化し、API レスポンスを復号化するためのクライアントシークレット。これは、[POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) を除くすべてのエンドポイントで必要です。<br/>詳細と、いくつかのプログラミング言語での暗号化/復号化の例は、[Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md) を参照してください。
- API リクエストを暗号化し、API レスポンスを復号化するための Client Secret 。これは、[POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) を除くすべてのエンドポイントで必要です。<br/>詳細と、いくつかのプログラミング言語での暗号化/復号化の例は、[Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md) を参照してください。

:::note
パブリッシャーの場合、Client-Side に UID2 を実装しているなら、認証と認可は Prebid.js ([UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) を参照) や JavaScript SDK ([Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md) を参照) などの実装によって自動的に管理されます。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ UID2 の <a href="../overviews/participants-overview#uid2-external-participants"
| Audience | Credentials | Integration |
| :--- | :--- | :--- |
| Client-Side 実装を使用する参加者 | 次の両方: <ul><li><Link href="../ref-info/glossary-uid#gl-subscription-id">Subscription ID</Link></li><li><Link href="../ref-info/glossary-uid#gl-public-key">Public key</Link></li></ul>これら 2 つをあわせて <Link href="../ref-info/glossary-uid#gl-client-keypair">client keypair</Link> と呼ぶこともあります。 | 次のいずれかを使用したインテグレーション: <ul><li>[UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)</li><li>[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)</li><li>[UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)</li></ul> |
| Client-Server 実装を使用する参加者 | 次の両方:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link>は、参加者と UID2 Service のみが知る値です。</li></ul> | 次のいずれかを使用したインテグレーション: <ul><li>[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)</li></ul> |
| Server-Side 実装を使用する参加者 | 次の両方:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link>は、参加者と UID2 Service のみが知る値です。</li></ul> | 次のいずれかを使用したインテグレーション: <ul><li>[Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)</li><li>[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)</li></ul> |
| Client-Server 実装を使用する参加者 | 次の両方:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link>は、参加者と UID2 Service のみが知る値です。</li></ul> | 次のいずれかを使用したインテグレーション: <ul><li>[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)</li></ul> |
| Server-Side 実装を使用する参加者 | 次の両方:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link>は、参加者と UID2 Service のみが知る値です。</li></ul> | 次のいずれかを使用したインテグレーション: <ul><li>[Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)</li><li>[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)</li></ul> |

## Separate Credentials Per Environment/Role

Expand Down Expand Up @@ -89,36 +89,36 @@ UID2 を Client-Side で実装する場合、UID2 JavaScript SDK、Client-Side I

Notes:

- API キーとクライアントシークレットとは異なり、Subscription ID と Public key は安全に保管する必要はありません。
- API キーと Client Secret とは異なり、Subscription ID と Public key は安全に保管する必要はありません。

- 値は特定の [environment](gs-environments.md) で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに認証情報のセットを取得します。

- Subscription ID と Public Key の認証情報は、Client-Side トークンの生成にのみ使用できます。追加のロールが必要な場合は ([API Permissions](gs-permissions.md) を参照)、そのロールの API キーとクライアントシークレットをリクエストしてください
- Subscription ID と Public Key の認証情報は、Client-Side トークンの生成にのみ使用できます。追加のロールが必要な場合は ([API Permissions](gs-permissions.md) を参照)、そのロールの API キーと Client Secret をリクエストしてください

## API Key and Client Secret

Client-Server または Server-Side の実装を使用している場合([UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) または [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、API Key とクライアントシークレットを使用して、<Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。
Client-Server または Server-Side の実装を使用している場合([UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) または [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md) を参照)、API Key と Client Secret を使用して、<Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。

以下は API Key とクライアントシークレットに関する情報です:
以下は API Key と Client Secret に関する情報です:
- これらの値は安全に保管する必要があります。詳細は、[Security of API Key and Client Secret](#security-of-api-key-and-client-secret) を参照してください。
- UID2 参加者は、複数のキーを持つことができます。
- 各キーには、それを使用できるエンドポイントを決定する [権限](gs-permissions.md) のセットがあります。
- 各キーには対応するクライアントシークレットがあります
- ほとんどの API エンドポイントは、認証のために API Key とクライアントシークレットの両方を必要とします。詳細は [Authentication and Authorization](gs-auth.md) を参照してください。
- 各キーには対応する Client Secret があります
- ほとんどの API エンドポイントは、認証のために API Key と Client Secret の両方を必要とします。詳細は [Authentication and Authorization](gs-auth.md) を参照してください。
- インテグレーション環境と本番環境の両方を使用する場合、環境ごとに個別の API Key を受け取ります。
- クライアントシークレットは特定の [environment](gs-environments.md) で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとにクライアントシークレットを取得します
- Client Secret は特定の [environment](gs-environments.md) で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに Client Secret を取得します

UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応するクライアントシークレットが割り当てられます。連絡先の詳細は [Contact Info](gs-account-setup.md#contact-info) を参照してください。
UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応する Client Secret が割り当てられます。連絡先の詳細は [Contact Info](gs-account-setup.md#contact-info) を参照してください。

### Security of API Key and Client Secret

キーとクライアントシークレットのセキュリティは非常に重要です。以下のガイドラインに従ってください:
キーと Client Secret のセキュリティは非常に重要です。以下のガイドラインに従ってください:

- API Key とクライアントシークレットを受け取ったら、安全な場所に保管してください。
- API Key と Client Secret を受け取ったら、安全な場所に保管してください。
- これらの値が保存され使用されているすべての場所を追跡しておき、キーをローテーションする必要がある場合にすぐに実行できるようにしておいてください。
- 既存のキーとシークレットが漏洩した場合、新しいキーとシークレットに置き換えるプロセスを確立してください。

API Key とクライアントシークレットは、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新することを推奨します。
API Key と Client Secret は、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新することを推奨します。

## Refreshing Credentials

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import SnptIdentityGenerateResponse from '../snippets/_snpt-example-identity-gen

UID2 API リクエストの暗号化と各レスポンスの復号化について知っておく必要があるのは、以下のとおりです:

- API を使用するには、クライアントの API Key に加えて、クライアントシークレットが必要です
- API を使用するには、クライアントの API Key に加えて、 Client Secret が必要です
- 独自のコードを書くことも、提供されているコード例の一つを使うこともできます: [Encryption and Decryption Code Examples](#encryption-and-decryption-code-examples) を参照してください。
- リクエストとレスポンスには、96 ビットの初期化ベクトルと 128 ビットの認証タグを持つ AES/GCM/NoPadding 暗号化アルゴリズムが使用されます。
- リクエストの暗号化されていない JSON ボディは、バイナリの [暗号化前リクエストデータエンベローブ](#unencrypted-request-data-envelope) にラップされ、その後 [暗号化リクエストエンベローブ](#encrypted-request-envelope) に従って暗号化とフォーマットが行われます。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ UID2 とインテグレーションするには、UID2 アカウントが必要
UID2 Portal の [API Keys](../portal/api-keys.md) ページで、次の値を設定する必要があります:

- <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link> (Client Key とも呼ばれます)
- <Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link> (参加者と UID2 Service のみが知る値です)
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link> (参加者と UID2 Service のみが知る値です)

:::important
これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ UID2 とインテグレーションするには、UID2 のアカウントが必

- Client-Server または Server-Side の実装の場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで次の値を設定する必要があります:
- <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。
- <Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link>、参加者と UID2 Service のみが知る値です。
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link>、参加者と UID2 Service のみが知る値です。

:::important
これらの値を安全に保管することは非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ UID2 とインテグレーションするには、UID2 アカウントが必要

- Client-Server または Server-Side の実装の場合、UID2 Portal の [API Keys](../portal/api-keys.md) ページで次の値を設定する必要があります:
- <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。
- <Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link>、参加者と UID2 Service のみが知っている値。
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link>、参加者と UID2 Service のみが知っている値。

:::important
これらの値を安全に保管することが非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ UID2 とインテグレーションするには、UID2 アカウントが必要
Client-Server インテグレーションを行う場合は、UID2 Portal の [API Keys](../portal/api-keys.md) ページで以下の値を設定する必要があります:

- <Link href="../ref-info/glossary-uid#gl-api-key">API Key</Link>、Client Key とも呼ばれます。
- <Link href="../ref-info/glossary-uid#gl-client-secret">クライアントシークレット</Link>、参加者と UID2 Service のみが知る値です。
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client Secret</Link>、参加者と UID2 Service のみが知る値です。

:::important
これらの値を安全に保管することは非常に重要です。詳細は、[Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
Expand Down Expand Up @@ -101,7 +101,7 @@ Step 1-c でパブリッシャーがユーザーのメールアドレスまた
`Identity` レスポンスを SDK に渡す必要があります。[Sending the UID2 Token to the SDK](#sending-the-uid2-token-to-the-sdk) を参照してください。

:::warning
セキュリティ上の理由から、トークン生成に使用される API Key とクライアントシークレットは Server-Side で呼び出す必要があります。これらの値を Client-Side に保存しないでください。詳細は [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
セキュリティ上の理由から、トークン生成に使用される API Key と Client Secret は Server-Side で呼び出す必要があります。これらの値を Client-Side に保存しないでください。詳細は [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret) を参照してください。
:::

#### Sending the UID2 Token to the SDK
Expand Down
Loading
Loading