FairBid Management API

Authentication Apps Placements Instances

Introduction to the Management API

The process of creating and maintaining waterfalls is both time and resource consuming. Once you have completed the verification process, the Management API provides a simple and quick method for publishers to create and maintain all settings required to monetize their apps with ads.

With the Management API you can perform the following functions for Apps, Placements and Instances:

  • Get (retrieve)
  • Create
  • Update
  • Delete

The Management API enables automation of the processes, when relying on insights and decisions taken on the publisher side.

User Verification

Fyber’s API endpoints are secured, and must be used with an authentication token.

The first step is to obtain an authorization header for authentication. This enables you to use the Management API and be verified as a user within the Fyber Console.

Generating your verification keys:

  1. Click your login user name in the top-left corner
    Screen_Shot_2021-11-15_at_10.02.22_censored.jpg
  2. Click User Profile to open the User Profile Window

In the Management API - Credentials section, the Client ID and Client Secret Keys are displayed.

Note

Click Revoke to cancel the Client ID and Client Secret keys. Then click Generate New Keys to receive new keys.

The keys you have generated must now be placed in the Endpoint to generate your Access Token to the Management API.

Generating Your Access Token

Copy both the Client ID and Client Secret keys and create an HTTP request with the following body.

Description

Use the UI Management API credentials to authenticate your user and get back an access token to authorize further requests.

Method

POST htpps://console.fyber.com/api/v2/management/auth

Request Parameters

Key Description Type Required Example
grant_type

This key is constant and should always be completed for this API as "management_client
_credentials"

String

Required

"management_client_
credentials"
client_id The Client ID token from the UI received for authentication. String Required “677eXXXXXXcdcc3fd790
deb46duyud4”
client_secret The Client Secret token from the UI received for authentication. String Required “ghhjhiGHXXXXXX87686"

Example Request

{
          "grant_type": "management_client_credentials",
          "client_id": "677e6543049XXXXXXXXX0deb46d2ecd4",
          "client_secret": "d0iSLq5y6XXXXXuOyM4blm8GwzQ
b2sLOlcBtsI9KvBx9tGuucM2kvrdxXXXXXPjIunXbATQTkHDjHv
VEVv1JgXFj0EUWmuNpNH53p9SnGWxwXXXXgdJSkCUDuHaDeFWH
z-prMEGftXXXXXXfa_-8mRZURDZu2d_CRnwZ-Z51EnuFszgEP0
4f1AjcKTVhNSw0rXXXXXXdKaGZNM4EPsV5SxLBZKKdQxa3PPW
L1Cb56U9ftviXPJKU47nAzXXXXXXXdfXKBsMCG2FX3nB7E2Ei
b_yHNK0EtXX4zFTr8uYRXXXXXXXCLMVRUxNjQ" }

Response Parameters

Key Description Type Required Example
accessToken Token to be used to authorize future requests String Required

“eyJhbGciXXXXXXXXsInR5cCI6IkpXVC
J9.eyJpYXQiOjE2Mjg2NzI4OTMsImV4c
CI6MTYyODXXXXXXwiYXVkIjoibWFu
YWdlbWVudEFXXXXN1YiI6IjM2MiJ9.
cjx3AgYcI0XXXXYkVsO6F_7M72lu_p ”

tokenType Only bearer token type is available String Required “bearer”
expiresIn The number of seconds for which the token is valid (3600 seconds = 1 hour) String Required

3600 

Example Response

{
          "accessToken": "eyJhbGciXXXXXiIsInR5cCI6IkpXVCJ9.
eyJpYXQiOjE2Mjg2NzI4OTMsIXXXXXXXODY3NjQ5MywiYXfdhei
bWFuYWdlbWVuXXXXXXXnN1YiI6IjM2MiJ9.cjx3AgYcI0w5qG0YkVs
O6F_7M72lu_pqSqtXXXXXU", "tokenType": "bearer", "expiresIn": 3600 }

Back to Top ⇧