Obtain OAuth Credentials

The first step towards gaining access to the BrightRoll DSP APIs is to obtain authentication credentials (client ID, client secret, and authorization code) for your YDN app.

This page provides step-by-step instructions that will enable you to gain administrative access to your BrightRoll DSP seat, join the Yahoo Developer Network, create a YDN app, and acquire the authentication credentials that will enable your YDN app to access the BrightRoll DSP APIs.

Prerequisites

This procedure assumes that you have the following prerequisites:

  • Seat license. You must have access to a seat on the BrightRoll DSP.
  • Valid email address. You must provide a provide an email address. If you have access to the BrightRoll DSP UI, do not use the same email address that you use to log into the UI. If you are an Oath/Yahoo employee, do not use your oath.com / yahoo-inc.com email address.

Step 1: Request API Access to the Seat

Depending on whether you are an external developer or internal developer, you must request BrightRoll DSP API access and OAuth support from either an account manager or Yahoo product support.

  • External developers can obtain access by sending an email request to their account manager.
  • Internal developers can obtain access by sending an email request to Yahoo product support.

You will be notified by email once you are registered. The email will sent to the email address that you provide your account manager or product support engineer.

To request API access (for existing UI user):

If you already have access to the DSP UI and would like to enable API access for the same seat, skip to Enable API Access.

To request API access (for external users):

To request API access to your seat, contact your account manager and ask that your email address be registered with your BrightRoll DSP seat.

Be sure to provide the account manager with a valid email address. You will be notified by email once you are registered.

To request API access (for internal users):

To request API access to your seat, contact product support and ask that for API access to the seat. Provide a @yahoo.com email address and ask that the email address be registered with your BrightRoll DSP seat.

Note

For internal users (Oath/Yahoo), your @oath.com or @yahoo-inc.com address will not work. You must provide a new or existing @yahoo.com email address.

You will will be notified by email once you are registered.

Step 2: Set Up an Admin Account

In this step, you will accept the invitation to join the seat with a new admin account and associate that account with the email address you provided your account manager or product support engineer.

The invitation email is valid for only 72 hours.

To set up a BrightRoll DSP admin account:

  1. Open the invitation email.

    The invitation email will be sent to the email address you provided your account manager or product support engineer.

    https://s.yimg.com/oo/cms/products/brightroll-dsp-api/authentication/images/email_1dc378827.png
  2. Click the Accept Invitation button.

    The Welcome to the BrightRoll DSP+ window appears.

    https://s.yimg.com/oo/cms/products/brightroll-dsp-api/authentication/images/invitation_4f77a56ff.png
  3. Click the Continue button.

Congratulations, you have set up your admin account. As an administrator, you can grant yourself API and OAuth access to the seat.

Step 3: Enable OAuth Authentication Support

In the BrightRoll DSP client, enable support for BrightRoll DSP API and for OAUTH authentication in the My Account page:

https://s.yimg.com/oo/cms/products/brightroll-dsp-api/authentication/images/user-admin_326902118.png

The procedure is slightly different for external and internal users:

  • External users must enable API support and enable OAuth authentication.
  • Internal users must enable OAuth authentication.

To enable API and OAuth support:

  1. Click the User Account button and select My Account in the shortcut menu.

    The Edit User page appears.

  2. If you are an external user, enable the API access flag.

  3. Select OAUTH as the Auth Type.

  4. Click the Save User button.

Step 4: Create a YDN App

To create a YDN app:

  1. Navigate to the Yahoo Developer Network: https://developer.yahoo.com.
If you are on the Yahoo corporate network, use an incognito/private browser window.
  1. Click the Sign In button.

  2. Sign into the Yahoo Developer Network using your email credentials.

  3. Click My Apps and select the YDN Apps option in the shortcut menu.

    The My Apps page appears.

    The Create an App button
  4. Click the Create an App button.

    The Create Application page appears.

    The Create an App button
  5. To configure your app, complete the fields in the form.

    Four fields are required:

    Field Description
    Application Name Choose a name you will remember.
    Application Type Select the Web Application option.
    Callback Domain Although not used in the API workflow, the callback domain is mandatory. Your users will be redirected to the specified doman if an API call fails.
    API Permissions Select the Yahoo Gemini Advertising (Read/Write) option.
  6. Click the Create App button.

    Your client ID and client secret are displayed at the top of the page.

    The Create an App button
  7. Copy and save your client ID and client secret. You need these credentials to access Yahoo API by OAuth.

You have generated the client ID and client secret. You will use these OAuth 2.0 credentials to generate the refresh and access tokens that your app will use to connect to YDN.

  • CLIENT_ID. The client ID is an OAuth 2.0 credential that uniquely identifies your app.
  • CLIENT_SECRET The client secret is an OAuth 2.0 credential that is known by both YDN and your app.

Step 5: Generate Authorization Code

In this step, you will submit a request for an authorization code using your YDN app’s client ID.

The YDN authorization server returns an authorization code.

To generate an authorization code:

  1. Open a web browser and enter the following URL in your browser. Substitute your app’s client ID for the CLIENT_ID placeholder in the URL.
https://api.login.yahoo.com/oauth2/request_auth?client_id=CLIENT_ID&redirect_uri=oob&response_type=code&language=en-us

The browser redirects to another page asks to agree with the terms of service.

Allow application access
  1. Review the Yahoo OpenID and OAuth terms and click the Agree button.

    The Sharing Approval page appears displaying your authorization code.

    Approve sharing of access with application
  2. Copy and save the authorization code.

The AUTHORIZATION_CODE is one of the OAuth 2.0 credentials that your app will use to generate its access and refresh tokens.
  1. Click the Close button.

Congratulations! You have completed the one-time OAuth setup process and acquired the authentication credentials you will need to generate your access tokens.

For step-by-step instructions on how to generate the access token needed to make API calls, go to the Generate OAuth Tokens page.