Offerwall iFrame API Access
The AppsPrize Offerwall API provides a solution for publishers who want to include an offerwall in their application/website but have control over the presentation of the offers. All offers matching the parameters provided will be returned and can be displayed to the user.
You can access the API on:
https://web-offerwall.appsprize.com/?token=YOUR_TOKEN_ID&userid={YOUR_USER_ID_MACRO}
For server-side request, following parameters that can be used:
| Parameters | Description | Format | Sample | Type |
|---|---|---|---|---|
| userid | Unique client's user ID | String | 123456 | Mandatory |
| token | Unique client's iframe token | String | as9GqumRByGZhNvN3f2pORG-VnRw22ZG16Mn | Mandatory |
| country_code | Country code of the user's location | String | US, CA, GB, etc... | Optional |
| os | The user's platform that clicks on | String | android, ios, web | Optional |
| extra_2 | A custom parameter value as set by the publisher | String | Optional | |
| extra_3 | A custom parameter value as set by the publisher | String | Optional | |
| extra_4 | A custom parameter value as set by the publisher | String | Optional | |
| extra_5 | A custom parameter value as set by the publisher | String | Optional |
token;
can be generated after you provide a callback/postback address. AppsPrize will define the postback on their side and generate an iframe API with a unique token id.
userid;
in order to filter the offerwall per user, it must be the user ID parameter you use
for your server.
Custom Parameters;
You can use "extra" parameters if you would like to add custom parameters and in order to get them back on postback request, you need to implement it on your endpoint.
country_code;
is optional, if you cannot use the country_code, when a user clicks on the iframe page, we will get the IP of the users by client-side request and return the offers according to their location.
os;
You can use "os" parameter in order to filter the offers according to platform that user has. If you don't use this parameter, iframe page will show "All, Android, iOS" tabs and sort accordingly.
Updated 9 months ago