メインコンテンツまでスキップ

POST /token/validate

Advertising Token が指定されたハッシュ化された、またはハッシュ化されていないメールアドレスまたは電話番号と一致するかどうかを検証します。

Used by: このエンドポイントは、主にパブリッシャーが使用します。

NOTE: このエンドポイントは、主に新しいインテグレーションのテストとトラブルシューティングのために用意されています。

Request Format

POST '{environment}/v2/token/validate'

IMPORTANT: すべてのリクエストは、秘密鍵を使用して暗号化する必要があります。詳細と Python スクリプトの例は、リクエストの暗号化とレスポンスの復号化 を参照してください。

Path Parameters

Path ParameterData TypeAttributeDescription
{environment}string必須テスト環境: https://operator-integ.uidapi.com
本番環境: https://prod.uidapi.com
リージョンごとのオペレーターを含む全リストは Environments を参照してください。

NOTE: インテグレーション環境と本番環境では、異なる APIキー が必要です。

Unencrypted JSON Body Parameters

  • Body Parameter の表にあるように、以下の4つの有効なオプションのうち1つだけを含めます: emailemail_hashphonephone_hash のいずれかです。テストするパラメータには、リストされている値を正確に指定してください。
Body ParameterData TypeAttributeDescription
tokenstringRequiredPOST /token/generate レスポンスが返す Advertising Token です。
emailstringConditionally Requiredトークン検証用のメールアドレスです。
有効な値は validate@email.com だけです。
email_hashstringConditionally Requiredトークン検証用の 正規化された メールアドレス(validate@email.com) の Base64-encoded SHA-256 ハッシュです。
有効な値は ntI244ZRTXwAwpki6/M5cyBYW7h/Wq576lnN3l9+W/c= だけです。
phonestringConditionally Requiredトークンを生成するための 正規化された 電話番号です。
有効な値は+12345678901 だけです。
phone_hashstringConditionally Required正規化された 電話番号の Base64-encoded SHA-256 ハッシュです。
有効な値は EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4= だけです。

Request Examples

以下は、各パラメータの暗号化されていない JSON リクエストボディの例で、トークン検証のリクエストに含める必要があります:

NOTE: 以下の例の 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]

詳細と Python スクリプトの例は、リクエストの暗号化とレスポンスの復号化 を参照してください。

Decrypted JSON Response Format

NOTE: レスポンスは、HTTP ステータスコードが 200 の場合のみ暗号化されます。それ以外の場合、レスポンスは暗号化されません。

復号化に成功したレスポンスは、以下の例に示すように、指定された Advertising Token の検証結果を示す論理値を返します。

{
"body": true,
"status": "success"
}

Body Response Properties

PropertyData TypeDescription
bodybooleantrueの値は、リクエストで指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、Advertising Token を生成するために使用されたものと同じであることを示します。
falseの値は、次のいずれかを示します:
- リクエストに無効な Advertising Token が含まれていました。
- リクエストに指定されたメールアドレス、電話番号、またはそれぞれのハッシュが、暗号化されていないJSONボディパラメータ テーブルで指定された4つの有効な値のうちの1つではありません。

Response Status Codes

次の表は、status プロパティの値と、それに対応する HTTP ステータスコードの一覧です。

StatusHTTP Status CodeDescription
success200リクエストは成功しました。レスポンスは暗号化されています。
client_error400リクエストに不足している、または無効なパラメータがありました。
unauthorized401クエストにベアラートークンが含まれていない、無効なベアラートークンが含まれている、またはリクエストされた操作を実行するのに許可されていないベアラートークンが含まれていました。

status の値が success 以外であれば、 message フィールドにその問題に関する追加情報が表示されます。

Using POST /token/validate to Test

このエンドポイントを使用して、POST /token/generate で送信する DII が有効かどうかをテストできます。以下の手順に従ってください。

  1. DII がハッシュ化されたメールアドレスか、ハッシュ化されていないメールアドレスか、電話番号かに応じて、Unencrypted JSON Body Parameters の表に記載されている4つの有効なオプションのいずれかを使用して、POST /token/generate リクエストを送信します。表に記載されている対応する値 - emailemail_hashphonephone_hash - を使用します。

  2. 返された advertising_token の値を次のステップで使用するために保存します。

  3. Step 1 で送信した emailemail_hashphonephone_hash の値と、Step 2 で保存した advertising_tokentoken プロパティの値として、POST /token/validate リクエストを送信します。

  4. POST /token/validate リクエストに対するレスポンスを確認します。結果は以下のように、処理の成功を示しています:

    • true のレスポンスは、Step 1 でリクエストとして送った DII が、Step 1 のレスポンスで受け取ったトークンと一致していることを示します。
    • false のレスポンスは、メールアドレス、電話番号、またはそれぞれのハッシュを送信する方法に問題があるかもしれないことを示します。