Offer API

Rank and Save Offers on Your Backend with the Offer API

Improve performance and flexibility by ranking and saving offers directly on your backend using Studio. This approach reduces the number of SDK calls by allowing a single backend request to render multiple offers, leading to faster load times and a smoother user experience.

By implementing custom ranking logic, you can prioritize or filter offers based on your specific business goals. Additionally, this setup allows you to optimize rewards by promoting offers that deliver higher engagement value.

Overview

Offer API Specification

get

Path parameters

userUUIDstringRequired

external User UUID

Query parameters

categorystringOptional

app category: gaming, non-gaming or both

Header parameters

Adjoe-SDKHashstringRequired

SDK hash

x-api-keystringRequired

API auth token

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

get

/studio-sdk/user/{userUUID}/offers

HTTPcURLJavaScriptPython

GET /v1/studio-sdk/user/{userUUID}/offers HTTP/1.1
Host: prod.adjoe.zone
Adjoe-SDKHash: text
x-api-key: text
Accept: */*

{
  "Offers": [
    {
      "AlreadyClicked": true,
      "AppID": "406889139",
      "AppName": "Coin Master",
      "CPI": 0.3,
      "Coins": 25,
      "ECPM": 120,
      "PlacementPosition": 1,
      "Score": 120,
      "Token": "ee0f45561e1e9ee322078aa7cf4712e1e3cc481a50cab555c909617aedb9f91b07f6a2e8b104ad2958a9fb0fd5a05e7b117d448c7a84f54c41fa16abba954da20bfc2633bb77e94b6028a7338a22663e982b1b846e461687e8d4c7614fbafeed2c10c15af0437a5c17134ac9fb98d0f0bc34dbc00d8692920f47179c8af3a7522cf8af437fb563ff321d562a8562e30eb63815bddffb30e1e06444d8394f41"
    }
  ]
}

Integration Steps

1

Call API

• Set up your backend to send requests to the Offer API.

• Use the API Token provided by your Account Manager for API authentication.

Offers will only be returned for old users or user that have previously initialized.

2

Pass token to SDK

Use the token returned by Offer API to get the campaign details from the SDK

iOS

getCampaigns(token: "ee0f45561e1e9ee322078aa7cf4712e1e3cc481a50cab555c909617aedb9f91b07f6a2e8b104ad2958a9fb0fd5a05e7b117d448c7a84f54c41fa16abba954da20bfc2633bb77e94b6028a7338a22663e982b1b846e461687e8d4c7614fbafeed2c10c15af0437a5c17134ac9fb98d0f0bc34dbc00d8692920f47179c8af3a7522cf8af437fb563ff321d562a8562e30eb63815bddffb30e1e06444d8394f41", options: PlaytimeOptions)

Android

3

SDK Returns Campaign Details

The SDK returns a list of offers that can be rendered in various formats.

4

Render Offers in the UI

Use SDK models to build your custom offer UI.

Single Offer	Offer Carousel	Offerwall

IP Whitelisting

Please provide your IP addresses so we can whitelist them and ensure requests are from your endpoint.

Rate Limiting

Currently, there is no rate limiting in place. However, it will be introduced soon, and you will be notified well in advance.

No Campaigns Returned

There may be some instances where the API return no offers for the user. This mainly happens for the following reasons and may only be temporary:

• Advertiser constraints (budget, targeting, user attribution, etc)

• VPN/Travelling

In case no campaigns are returned for the user, you should build a user experience around this, e.g., UI to indicate to the user that no games are available at the moment.