POST /token/validate
Advertising Token が指定されたハッシュ化された、またはハッシュされていないメールアドレスまたは電話番号と一致するかどうかを検証します。
Used by: このエンドポイントは、主にパブリッシャーが使用します。
このエンドポイントは、主に新しいインテグレーションのテストとトラブルシューティングのために用意されています。
Request Format
POST '{environment}/v2/token/validate'
認証の詳細は、 Authentication and Authorization を参照してください。
すべてのリクエストを秘密鍵で暗号化する必要があります。詳細といくつかのプログラミング言語でのコードの例は、Encrypting Requests and Decrypting Responses を参照してください。
Path Parameters
| Path Parameter | Data Type | Attribute | Description |
|---|---|---|---|
{environment} | string | 必須 | テスト (インテグレーション) 環境: https://operator-integ.uidapi.com本番環境: https://prod.uidapi.comリージョンごとのオペレーターを含む全リストは Environments を参照してください。 |
インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法は、Getting Your Credentials を参照してください。
Unencrypted JSON Body Parameters
このエンドポイントの使用に関する主なポイントは以下の通りです。
- 次の 4 つの有効なオプションのいずれかを、Body Parameter テーブルに記載されているように、1 つだけ含めます:
email、email_hash、phone、またはphone_hash。 - 暗号化する際に、必要なボディパラメータをリクエストの JSON ボディ内のキーと値のペアとして含めます。
| Body Parameter | Data Type | Attribute | Description |
|---|---|---|---|
token | string | 必須 | POST /token/generate レスポンスによって返された Advertising Token です。 自身の認証情報で生成された Advertising Token のみを検証できます。 |
email | string | 条件付きで必須 | トークン検証用のメールアドレスです。正規化されているかどうかに関わらず、有効なメールアドレス値を使用できます。 |
email_hash | string | 条件付きで必須 | 有効な 正規化された メールアドレスの Base64-encoded SHA-256 ハッシュです。 |
phone | string | 条件付きで必須 | トークン検証用の電話番号です。有効な電話番号値を使用できますが、正規化されている必要があります。 |
phone_hash | string | 条件付きで必須 | 有効な 正規化された 電話番号の Base64-encoded SHA-256 ハッシュです。 |
Request Examples
以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、トークン検証のリクエストに含める必要があります:
以下の例の Advertising Token は、説明のみを目的とした架空のものです。提供された値は実際の値ではありません。
{
"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D",
"email": "validate@example.com"
}
{
"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D",
"email_hash": "ntI244ZRTXwAwpki6/M5cyBYW7h/Wq576lnN3l9+W/c="
}
{
"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D",
"phone": "+12345678901"
}
{
"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D",
"phone_hash": "EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4="
}
以下は 、メールアドレスハッシュの暗号化トークン検証リクエストの例です:
echo '{"token": "AdvertisingTokenmZ4dZgeuXXl6DhoXqbRXQbHlHhA96leN94U1uavZVspwKXlfWETZ3b%2FbesPFFvJxNLLySg4QEYHUAiyUrNncgnm7ppu0mi6wU2CW6hssiuEkKfstbo9XWgRUbWNTM%2BewMzXXM8G9j8Q%3D", "email_hash": "LdhtUlMQ58ZZy5YUqGPRQw5xUMS5dXG5ocJHYJHbAKI="}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/validate [Your-Client-API-Key] [Your-Client-Secret]
詳細といくつかのプログラミング言語でのコードの例は、Encrypting Requests and Decrypting Responses を参照してください。
Decrypted JSON Response Format
レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。
復号化に成功したレスポンスは、以下の例に示すように、指定された Advertising Token の検証結果を示す論理値を返します。
{
"body": true,
"status": "success"
}
Body Response Properties
以下の表は、レスポンスボディに関する情報を提供します。
| Property | Data Type | Description |
|---|---|---|
body | boolean | true の値は、リクエストで指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、Advertising Token を生成するために使用されたものと同じであることを示します。false の値は、リクエストで指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、Advertising Token を生成するために使用されたものと同じではないことを示します。 |
Response Status Codes
次の表は、status プロパティの値と、それに対応する HTTP ステータスコードの一覧です。
| Status | HTTP Status Code | Description |
|---|---|---|
success | 200 | リクエストは成功しました。レスポンスは暗号化されています。 |
client_error | 400 | リクエストに不足している、または無効なパラメータがありました。 |
unauthorized | 401 | リクエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました。 |
status の値が success 以外であれば、message フィールドにその問題に関する追加情報が表示されます。
Using POST /token/validate to Test
このエンドポイントを使用して、POST /token/generate で送信する DII が有効かどうかをテストできます。以下の手順に従ってください。
- 検証する Advertising Token を生成するために、
email、email_hash、phone、またはphone_hashを使用して POST /token/generate リクエストを送信します。 - 次のステップで使用するために、返された
advertising_tokenの値を保存します。 - ステップ 1 で送信した
email、email_hash、phone、またはphone_hashの値と、ステップ 2 で保存したadvertising_tokenをtokenプロパティの値として使用して、POST /token/validateリクエストを送信します。 POST /token/validateリクエストへのレスポンスを確認します。結果は、以下のようにプロセスの成功を示します。trueのレスポンスは、ステップ 1 でリクエストとして送信した DII が、ステップ 1 のレスポンスで受け取ったトークンと一致することを示します。falseのレスポンスは、メールアドレス、電話番号、またはそれらのハッシュの送信方法に問題がある可能性があることを示します。