App Level

Here you can find the endpoints and parameters for Apps, using the DT FairBid Management API.

Get App/Apps

Description

Return the app's saved configuration by App ID.

Return all apps (of a single user)

Method

GET https://console.fyber.com/api/management/v1/app?appId=

GET https://console.fyber.com/api/management/v1/app?publisherId=

Request Parameters

Key	Description	Type	Required	Example
appId	The ID of the app	Number	Required	1070709
publisherId	The ID of the publisher	Number	Required	4

Example Request

https://console.fyber.com/api/management/v1/app?appId=170709

When a boolean field is left empty, the value of the empty string is automatically parsed as false.

Response Parameters

Key	Description	Type	Example
appId	DT App ID	String	“170709”
publisherId	DT Publisher ID	String	“3432”
name	The name of the app	String	“CashCrash”
bundle	App's android bundle or iOS Store ID	String	“com.cash_crash.54”
status	The status of the app. Can be either "active" or "inactive"	String	“active”
platform	App's platform (Android or iOS)	String	"android"
storeURL	App's store URL	String	“https://play.google.com/store /apps/details?id=com. bKash.customerapp“
category1	App's first store category	String	"Business"
category2	App's second store category	String	"Finance"
coppa	Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?	Boolean	false
rewardedAdUrl	URL to be used for server-side callbacks on app's rewarded placements	String	"https://mygamesdomain. com/callbacks.aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}} &signature={{SIG}}"
rewardedAdSecurityToken		String	“036xxxx5027e12c00f85a 4cbec3d1XXXXXa608cc 573a3482bXXXXX1164b8 64169”
activeMediatedNetworks	The selected mediated network. For a complete list of mediated networks, see Supported Networks.	String []	[“adColony”, “admob mediation”]

Example Response

JSON

{
       "appId": "170709",
       "publisherId": "4",
       "name": "bKash",
       "bundle": "com.bKash.customerapp",
       "status": "active",
       "platform": "android",
       "storeUrl": "https://play.google.com/store/apps/details?
id=com.bKash.customerapp",
       "category1": "Finance",
       "category2": "APPLICATION",
       "coppa": false,
       "rewardedAdUrl": "https://mygamesdomain.com/callbacks.
aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}}&
signature={{SIG}}",   "rewardedAdSecurityToken": 
"036ae5027XXXXXXXXX161a632a608cc573a3482b9c1XXXXX4b864169"
    "activeMediatedNetworks": [
           "Admob Mediation",
           "AdColony"      
       ]
    }
    

Create an App

Description

Create a new app.

Method

POST https://console.fyber.com/api/management/v1/app

Request Parameters

Key	Description	Type	Required	Example
name	The name of the app	String	Required	"CashCrash"
bundle	App's Android bundle or iOS Store ID	String	Required	"com.cash_crash.54"
platform	App's platform (Android or iOS)	String	Required	"android"
category1	App's first store category	String	Required	"business"
coppa	Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?	String	Required	false
rewardedAdUrl	URL to be used for server side call back on app’s rewarded placements	String	Optional	"https://mygameesdomain.com /callbacks.aspx?user_id={{USER_ID}}&reward_amount ={{AMOUNT}}&signature={{SIG}}"
category2	App’s second store category	String	Optional	“Finance”

Example Request

JSON

{
        "appId": "170709",
    "publisherId": "3432",
    "status": "active",
    "name": "CashCrash",
        "coppa": true,
        "platform": "ios",
        "category1": "Books",
        "category2": "Business",
        "bundle": "com.cash_crash.54",
        "rewardedAdUrl": "https://mygameesdomain.com/callbacks
.aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}}
&signature={{SIG}}"
    }
    

Response Parameters

Key	Description	Type	Example
appId	DT App ID	Number	“170709”
publisherId	DT Publisher ID	Number	“3432”
name	The name of the App	String	“CashCrash”
bundle	App’s Android bundle or iOS store ID	String	“com.cash_crash.54”
status	The status of the app. Can be either "active" or "inactive"	String	“active”
platform	App’s platform (Android or iOS)	String	“android”
storeURL	App’s store URL	String	“https://play.google.com/store /apps/details?id=com.bKash. customerapp“
category1	App’s first store category	String	“Business”
category2	App’s second store category	String	"Finance"
coppa	Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?	Boolean	False
rewardedAdUrl	URL to be used for server side call back on app’s rewarded placements	String	"https://mygameesdomain.com/ callbacks.aspx?user_id={{USER_ID}} &reward_amount={{AMOUNT}} &signature={{SIG}}"
rewardedAdSecurityToken		String	“000096ae5027e12c00f 85a4XXXXXX3d161a632 a608ccXXXXXX82b9c 1151164b864169”

Example Response

JSON

{
       "appId": "170709",
       "publisherId": "4",
       "name": "CashCrash",
       "bundle": "com.cash_crash.54",
       "status": "active",
       "platform": "ios",
       "storeUrl": "",
       "category1": "Books",
       "category2": "Business",
       "coppa": true,
       "rewardedAdUrl": "https://mygameesdomain.com/callbacks
.aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}}
&signature={{SIG}}",   "rewardedAdSecurityToken": 
"d613c47d081eXXXXXXXXXXf19f90a197ba4b5057556493f1e5759b14c"
    }
    

Update an App

Description

Update an existing app.

Method

PUT https://console.fyber.com/api/management/v1/app

Request Parameters

Key	Description	Type	Required	Example
appId	DT App ID	Number	Required	"170709"
status	The status of the app. Can be either "active" or "inactive"	String	Optional	"active"
coppa	Children's Online Privacy Protection Act. Is the app directed to children under 13 years of age?	Boolean	Optional	true
rewardedAdUrl	URL to be used for server-side call back on app's rewarded placements	String	Optional	"https://mygameesdomain.com /callbacks.aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}}&signature={{SIG}}"

Example Request

JSON

{
       "appId": "178505",
       "coppa": true,
       "status": "inactive",
       "rewardedAdUrl": "https://check546745674.com/callbacks.
aspx?user_id={{USER_ID}}&reward_amount={{AMOUNT}}&signature
={{SIG}}"
    }
    

Delete an App

Description

Delete an existing app.

Method

DELETE https://console.fyber.com/api/management/v1/app

Request Parameters

Key	Description	Required	Type
appId	The ID of the app	Required	Number

Example Request

JSON

{
       "appId": "123123"
    }

Example Response

JSON

{
       "message": "App 178441 has been deleted successfully."
    }