API access

 

Buyer side

 

In order to enable API access for a user, you will need to use a user that has admin rights.

First step would be to log in to our platform. Then at the top-right corner find an icon(see screenshot) and go to “User management”.

In this window, you can create a new user or manage existing ones.

If you want to create a new user for API consumption, please, do so now.

Password has to meet our API standards:

  • At least one of each – Lower-case, Upper-case, special symbol and a number
  • 6 characters or more

Next, to give an API access press on the user’s name.

Now press “Module Access”

In this window(see screenshot below) at the bottom you will find an “External API” and “Reporting stats API” checkboxes. To use APIs tick the first one, if you need to use Reporting stats API tick its checkbox too.

Keep in mind that, for example, if RTB setup is not checked, you will not be able to create RTB Line items in UI or API.

 

Once this is done, please, read the Authorization guide and provide Adform's API support team with required additional information according to the bullet-points in the "Prerequisites" part of this guide. 

When we have received the required information, OAuth client will be registered and credentials provided to you. 

 

Seller side

 

To create user, log in into our platform with a user that has admin rights.

Find an icon(see screenshot) at the top right corner of the screen and press “User Accounts”

 

Create a new user here by pressing “Create new Account”.

Once this is done, please, read the Authorization guide and provide Adform's API support team with required additional information according to the bullet-points in the "Prerequisites" part of this guide. 

When we have received the required information, OAuth client will be registered and credentials provided to you. 

 

Audience base side

 

Please contact audiencebase@adform.com and ask for a user with API access enabled

Postman based collection

Postman as a chrome extension is not fully compatible with OAuth and will return { "reason": "https_required" }

Please, use Postman's standalone application version. 

 

Next step is to start learning how our API services work. The best way to do it is to use our Postman based API collection. To download Postman, go to https://www.getpostman.com and download a version suitable for your operating system.

Once you have installed Postman, download our collection from GitHub 

DOWNLOAD

Then extract contents of a .Zip file and open Postman app. Next, press “Import” button on the top left corner (see screenshot)

 

Next, press “Import Folder” and choose a folder that you extracted from .Zip file.

Now, our collection is imported and you can try using our API services.

 

For ease of use when doing a login method, which is under Account-->Authentication, when the ticket is returned it is automatically saved as a variable named “Ticket” in Postman’s global variables (see screenshot)

 

You can use global variables in any part of Postman API call by using curly brackets as following {{VariableName}}

Help

Still have questions?

If you can't find an answer to your question here, email our Support team