Working with API Key

Owned by Former user (Deleted)
Last updated: Apr 11, 2023 by Freja Sari Sender (Unlicensed)
2 min read

What is an API Key?

An API key, also called API key, is a code which allows you to have access to your UI without having to login using your username and password. Having such a code is elementary when you want to create automated exports in order to export data from the platform automatically.
A typical API key looks more or less like this:

256a6f26-b72b-37f8e24ee373

Integrated in an export link, the API key needs to be added directly after the domain:

https://export-demonet.ingenioustech.biz/256a6f26-b72b-37f8e24ee373/adm-statssubid_2209.csv?filter[a:advertiser]=123&filter[timerange_type]=dynamic&filter[timerange]=thisweek1&filter[a:status]=3

Managing API keys

Every user has a default API key which is generated by the system. You will find your API key by going to the Access → API-Key Manager page. There you will find a key named Auto-Generated API Key (Created By System). You only need to create an API key if you need multiples ones.

You can revoke the default API key by deleting it. The system will create a new default API key automatically.

Getting started

In case you want to have multiple API keys for different use cases, you can create additional keys:

Make sure you are logged in, go to Access → API-Key Manager in the side menu.

If you do so, a page will appear that lists all your API-Keys.

The panel offers you an overview of all the API keys you have created so far. From left to right, you will find the name, the key itself, the expiration data and finally the status. Under Actions, you can find buttons to copy, revoke, edit and delete the API-Key.

Creating a new API key

To create a new API key, start by clicking on the button Create in the right top corner of the panel. If you do so, you will see a page looking more or less like this:

 

On this page, make sure you go through the following steps:

  • Start by giving your API key a name. It is recommended to make sure the purpose of the key, such as exporting day to day reports, exporting ad media, etc.

  • Define an expiration date. When you API key has expired, it will no longer give access to your admin UI anymore. Please note this step is not mandatory and you can decide not to end the validity of your key, but for reasons of security it is recommended.

  • Set the status of your API key on Activated.

When you are done, make sure you click on Save in the right lower corner of the page. If you do so, you will be taken back to the overview page, where you will see the new API key displayed.