UID2 SDK for Java (Server-Side) Reference Guide

You can use the UID2 SDK for Java (server-side) to facilitate the following:

• Generating UID2 advertising tokens
• Refreshing UID2 advertising tokens
• Encrypting raw UID2s to create UID2 tokens
• Decrypting UID2 advertising tokens to access the raw UID2s

Overview

The functions outlined here define the information that you'll need to configure or can retrieve from the library. The parameters and property names defined below are pseudocode. Actual parameters and property names vary by language but will be similar to the information outlined here.

Functionality

This SDK simplifies integration with UID2 for any publishers, DSPs, and UID2 sharers who are using Java for their server-side coding. The following table shows the functions it supports.

Encrypt Raw UID2 to UID2 Token	Decrypt UID2 Token	Generate UID2 Token from DII	Refresh UID2 Token
Supported	Supported	Supported	Supported

Version

The SDK requires Java version 1.8 or later.

GitHub Repository/Binary

This SDK is in the following open-source GitHub repository:

• UID2 SDK for Java

The binary is published on the Maven repository:

• https://central.sonatype.com/artifact/com.uid2/uid2-client

Initialization

The initialization function configures the parameters necessary for the SDK to authenticate with the UID2 service. It also allows you to configure retry intervals in the event of errors.

Parameter	Description	Recommended Value
endpoint	The endpoint for the UID2 service.	N/A
authKey	The authentication token that belongs to the client. For access to UID2, see Contact Info.	N/A

Interface

The interface allows you to decrypt UID2 advertising tokens and return the corresponding raw UID2.

NOTE: When you use an SDK, you do not need to store or manage decryption keys.

If you're a DSP, for bidding, call the interface to decrypt a UID2 advertising token and return the UID2. For details on the bidding logic for handling user opt-outs, see DSP Integration Guide.

The following is the decrypt method in Java:

import com.uid2.client.IUID2Client
 
IUID2Client client = UID2ClientFactory.create(TEST_ENDPOINT, TEST_API_KEY, TEST_SECRET_KEY);
client.refresh(); //Note that refresh() should be called once after create(), and then once per hour
DecryptionResponse result = client.decrypt(TEST_TOKEN);

Response Content

Available information returned through the SDK is outlined in the following table.

Function	Description
GetStatus()	The decryption result status. For a list of possible values and definitions, see Response Statuses.
GetUid()	The raw UID2 for the corresponding UID2 advertising token.
GetEstablished()	The timestamp indicating when a user first established the UID2 with the publisher.

Response Statuses

Value	Description
Success	The UID2 advertising token was decrypted successfully and a raw UID2 was returned.
NotAuthorizedForKey	The requester does not have authorization to decrypt this UID2 advertising token.
NotInitialized	The client library is waiting to be initialized.
InvalidPayload	The incoming UID2 advertising token is not a valid payload.
ExpiredToken	The incoming UID2 advertising token has expired.
KeysNotSynced	The client has failed to synchronize keys from the UID2 service.
VersionNotSupported	The client library does not support the version of the encrypted token.

Usage for UID2 Sharers

A UID2 sharer is any participant that wants to share UID2s with another participant. Raw UID2s must be encrypted into UID2 tokens before sending them to another participant. For an example of usage, see com.uid2.client.test.IntegrationExamples (runSharingExample method).

IMPORTANT: The UID2 token generated during this process is for sharing only—you cannot use it in the bid stream. There is a different workflow for generating tokens for the bid stream: see Sharing in the Bid Stream.

The following instructions provide an example of how you can implement sharing using the UID2 SDK for Java, either as a sender or a receiver.

1. Create an IUID2Client reference:

   IUID2Client client = UID2ClientFactory.create(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);

2. Refresh once at startup, and then periodically. Recommended refresh interval is hourly: for details, see Best Practices for Managing UID2 Tokens.

   client.refresh();

3. Senders:

   1. Call the following:

      EncryptionDataResponse encrypted = client.encrypt(rawUid);

   2. If encryption succeeded, send the UID2 token to the receiver:

      if (encrypted.isSuccess()) 
      { 
         //send encrypted.getEncryptedData() to receiver
      } 
      else 
      {
         //check encrypted.getStatus() for the failure reason
      }

4. Receivers:

   1. Call the following:

      DecryptionResponse decrypted = client.decrypt(uidToken);

   2. If decryption succeeded, use the raw UID2:

      if (decrypted.isSuccess()) 
      {
         //use decrypted.getUid() 
      } 
      else 
      {
       //check decrypted.getStatus() for the failure reason 
      }

FAQs

For a list of frequently asked questions for DSPs, see FAQs for DSPs.