Steps of using API

Using API one can get analytics of Eskimi platform as well as do other operations like creating campaigns etc. In this article the steps of using API is described. 

Create API client secret and token from Eskimi profile:

    1. In the dashboard UI page, in the top right corner click the three dot icon.
    2. Click on "API Clients".
    3. In API Clients UI page, in the top right corner click "Add Client".
    4. Enter the Client name (The name does not matter, it won't be used for the access token), and click on "Generate" for Client Secret. 
    5. Click Save button
    6. After refresh, you will be able then to click "Generate Client Token" button.
    7. Add your account password for security reasons and click "Confirm Identity & Generate"
    8. Your token will be generated and click "Copy" to save and use it for later. 
    9. Click Save

image.png

Token expiration term: 1 year.

 

Create API client secret from Eskimi profile and create token through API:

    1. In the dashboard UI page, in the top right corner click the three dot icon.
    2. Click on "API Clients".
    3. In API Clients UI page, in the top right corner click "Add Client".
    4. Enter the Client name (The name does not matter, it won't be used for the access token), and click on "Generate" for Client Secret.
    5. Save the changes and the API client will be created that will be used for getting Access Token.

       ScreenRecording2024-04-11at10.44.19-ezgif.com-video-to-gif-converter.gif

For the access token we recommend using postman, as it's show in the video. Here is a JSON format request for the authentication endpoint:

{ 
  "grant_type": "eskimi_dsp", 
  "username": "dsp_username", 
  "password": "Password", 
  "client_id": client_id, 
  "client_secret": "client_secret"
}

A request example for a reporting endpoints:

{ 
  "campaignIds": [ 
    000000 
  ], 
  "dateFrom": "2023-05-08", 
  "dateTo": "2023-05-12", 
  "byDate": true, 
  "byCampaign": false
}

From your parent account, you can access your child account data via API.



API Limitations:


Revision #24
Created 9 September 2021 12:19:30 by Hasnain Shahriar
Updated 18 December 2024 08:01:36 by Arūnas Butėnas