Setup & Access Guide

The Yahoo DSP API uses the OAuth 2.0 protocol as a simple and secure method for handling authentication and controlling access.

Important

In order to proceed with activating the DSP API, a user with access to the seat and is enabled for DSP API access must be established first. Confirm the following:

• User Exists: A user must have been created and enabled with API access via the DSP UI.

• Confirm User has API Access: If a user has not had DSP API access enabled, an “undefined” response will be returned when requesting the Client ID and Client Secret.

To create a user or have API access enabled for an existing user, someone with the User Ops role on the seat may complete these prerequisites via the Seat Settings > User section in the DSP UI. Reach out to your Yahoo Account Team for additional support with the email address for the user(s) needing to be created/access updated to assist.

For more details regarding how to manage users, a user with DSP UI access can reference the Manage Users article in the DSP Help Center.

Once the DSP APIs are activated, follow the steps to create an OAuth2 client of DSP. The client ID and client secret that you generate through this process are required to access Yahoo DSP API.

1. Get Your Client id and Client Secret

2. Generate the Access Token

3. Access the API

Get Your Client id and Client Secret

As a security measure the DSP UI only displays the client ID and secret once. If you lose your client ID and secret, reach out to DSP Support to obtain a new one.

1. Open the DSP UI.

2. In the upper-right corner of any DSP page, select your name. For example:

   

3. Select My Account from the list.

4. Select the Activate button.

   

5. Select Agree.

   A success message displays. The message includes your client ID and secret.

   

   Important

   If the DSP API has not been enabled for your account, a message will display that states the Client ID and Client Secret are undefined.

6. Copy the client ID and secret, and keep it in a safe place. You’ll need it later.

   Note

   Your client ID and secret are for your use only. For security purposes, if you suspect that someone other than you has obtained your client ID and secret, contact DSP Support immediately.

7. Select Close to close the success message.

Generate the Access Token

DSP uses OAuth2 for API authentication and authorization. The next step is to generate an access token using the client ID and secret provisioned above.

Once you generate the access token, you can access DSP REST API’s by passing the following two additional headers in the request.

About Access Tokens

DSP Uses the OAuth2 client_credentials workflow and identifies the client using a JSON Web Token to generate the access token. Complete the following two steps to the access token using the client ID and secret.

Note

• You don’t need to follow these steps manually. There are many robust scripts available in almost all the popular languages which will automate the above JWT generation based on the input provided.

• You can find a list of popular libraries at JWT. Be sure to choose one that supports HS256. Provide it the values defined below and it will generate the JWT for you.

Generate JSON Web Token

The OAuth2 client_credentials workflow uses a JSON Web Token (JWT) to identify the client. A JWT primarily consists of three parts:

1. Header - Normalized structure specifying how the token is signed.

2. A free set of claims.

3. A signature to ensure data integrity.

For Yahoo DSP, use the following values:

Header

{
   "alg" : "HS256"
   "typ": "jwt"
}

Payload

{
   "aud": "https://id.b2b.yahooincapis.com/zts/v1",
   "iss" : "idb2b.dsp.dspapi.<client_id>",
   "sub": "idb2b.dsp.dspapi.<client_id>",
   "exp" : <Expiry time as Unix Epoch in seconds>,
   "iat" : <issued at time as Unix Epoch in seconds>,
   "jti" : <UUID Unique identifier for the JWT>
}

Signature

{
   "signature" : "<signature generated using HS256 algorithm, see below>"
}

Generate the signature as follows:

jwt_signing_string = base64url_encode(header) + ‘.’ + base64url_encode(body)
jwt_signature = base64url_encode(hmac_sha256(jwt_signing_string, client_secret))
final_jwt = jwt_signing_string + ‘.’ + jwt_signature

The final JWT looks something like this:

ew0KICAiYWxnIjogIkhTMjU2IiwNCiAgICJ0eXAiOiAiSldUIg0KfQ.ew0KICAiYXVkIjogIntwcm90b
2NvbH06Ly97YjJiLmhvc3R9L2lkZW50aXR5L29hdXRoMi9hY2Nlc3NfdG9rZW4/cmVhbG09PHlvdXIt
cmVhbG0+IiwNCiAgImlzcyI6ICJ7Y2xpZW50X2lkfSIsDQogICJzdWIiOiAie2NsaWVudF9pZH0
iLA0KICAiZXhwIjog4oCce2V4cGlyeSB0aW1lIGluIHNlY29uZHN94oCdLA0KICAiaWF0Ijog4o
Cce2lzc3VlZCB0aW1lIGluIHNlY29uZHN94oCdDQp9DQo.uKqU9dTB6gKwG6jQCuXYAiMNdfN
Rw98Hw_IWuA5MaMo
<base64url-encoded header>.<base64url-encoded claims>.<base64url-encoded signature>

Note

They are separated with a “.”

Generate a JWT Access Token

Once you generate a JWT, you can use it to generate the access token using the Yahoo DSP.

Important

The expiry time should be less than 1 hour.

Request

POST https://id.b2b.yahooincapis.com/zts/v1/oauth2/token

Headers

FORM Parameters

Sample ‘curl’ Command

Here is a sample curl command for generating the access token:

curl "https://id.b2b.yahooincapis.com/zts/v1/oauth2/token" \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json" \
-d "grant_type=client_credentials&scope=api-client&realm=dsp&client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&client_assertion=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkLmIyYi52ZXJpem9ubWVkaWEuY29tL2lkZW50aXR5L29hdXRoMi9hY2Nlc3NfdG9rZW4_cmVhbG09ZHNwIiwiaXNzIjoiMTk3MDMxZTgtMTU0Ni00MTBmLTg0ZTMtY2Q2YzM4ZGJjZWMwIiwic3ViIjoiMTk3MDMxZTgtMTU0Ni00MTBmLTg0ZTMtY2Q2YzM4ZGJjZWMwIiwiZXhwIjoxNjIzNDQzNDAyfQ.HksbyvWXlvfbs3XI5Y_u50eWPiNc2-Qa2B4eGXLN6A"

Sample Response

{
   "access_token" : "3f94eb47-a295-4977-a375-e27bea5c828b",
   "scope" : "api-client",
   "token_type" : "Bearer",
   "expires_in" : "599"
}

Access the API

Once you have generated the access token, you can access Yahoo DSP by passing it in the ‘X-Auth-Token’ header along with the ‘X-Auth-Method : OAuth2’ header.

For example, to access the traffic API:

curl "https://dspapi.admanagerplus.yahoo.com/traffic/dictionary" \
-H "X-Auth-Method: OAuth2" \
-H "X-Auth-Token: 3f94eb47-a295-4977-a375-e27bea5c828b"