Authenticate With Adform APIs

Vaida
Vaida
  • Updated

To authenticate your OAuth client with Adform APIs, you need Client ID and Client Secret credentials. To receive your credentials, follow the procedure in Get Authentication Credentials for Adform APIs.

To start working with Adform APIs, you must select and set up an API platform to use, such as Postman. Follow these steps to configure Postman to work with Adform APIs:

  1. Download and install the Postman desktop app.

  2. Double-click the Postman icon to open the Postman desktop app.

  3. Click Postman-icon.png to open a new tab.

  4. In the dropdown menu, select GET method.

  5. In the request URL field, enter a full GET endpoint URL from an API you want to use, for example, https://api.adform.com/v1/seller/deals.

  6. Click the Authorization tab.

  7. In the Type dropdown menu, select OAuth 2.0.

  8. In the Configure New Token section, enter the required fields:

    1. Token Name: The name you want to use for your token.

    2. Grant type: In the dropdown menu, select Client Credentials.

    3. Access Token URL: https://id.adform.com/sts/connect/token.

    4. Client ID: Your username based on your access credentials.

    5. Client Secret: Your password based on your access credentials.

    6. Scope: Scope is the access needed for the API you want to use. Each access URL must be space-delimited. For example: https://api.adform.com/scope/api.placements.read https://api.adform.com/scope/seller.deals.

    7. Client Authentication: In the dropdown menu, select Send as Basic Auth header.

    8. Refresh Token URL: https://id.adform.com/sts/connect/authorize.

    The result should look like this:

    postman-authorization11.png

  9. Click Get New Access Token to generate a new token.

    Note

    Postman saves the configuration information together with the access token to use in later API calls.

  10. To use the token with your request, select Use Token and click Send.

    Note

    If there is an issue retrieving a new access token or you see an “Authentication Failed” message, check if you have the necessary permissions for all the listed access URLs and if there are no syntax errors in the access URLs list.

Postman configuration is successful if your API call returns the information you requested with the selected API endpoint. Following this example, you would receive a list of deal IDs that you have within your SSP account.

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!