The AppsPrize Offerwall API suits publishers who want an offerwall inside their application or website but want to keep control over how the offers are presented. Every offer matching the parameters you supply is returned, ready for you to display to the user.
Offerwall iFrame API access
The API is available at:
For a server-side request, these parameters are available:
| 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.
Postback endpoint structure
Use these parameters to set up a postback link:
| Parameter | Description |
|---|---|
extra_1 | It will be used for user ID, and mandatory |
payout | Payout will return with the offer CPI/CPA bid. |
offer_name | It will get request with the offer task. |
transaction_id | The unique transaction ID |
virtual_currency | Amount of virtual currency that the user will earn when completes the tasks. |
ip | IP of the user |
extra_2 | A custom parameter value as set by the publisher |
extra_3 | A custom parameter value as set by the publisher |
extra_4 | A custom parameter value as set by the publisher |
extra_5 | A custom parameter value as set by the publisher |
event_name | Completed event name of the CPA/multi-CPA offers |
A postback link might look like this:
https://your_domain.com/postback?YOUR_USER_ID_MACRO={extra_1}&YOUR_PAYOUT_MACRO={payout}&YOUR_OFFERNAME_MACRO={offer_name}&YOUR_TRANSACTION_ID_MACRO={transaction_id}&YOUR_VIRTUAL_CURRENCY_MACRO={virtual_currency}&YOUR_USER_IP_MACRO={ip}
AppsPrize has CPI and CPA offers, you will receive postbacks according to the conversion type.
If you would like to get event_name of the offers, you can give additional endpoint for event postback and append your corresponding parameter into it. Otherwise we can also use the same endpoint for event conversions. But please keep in mind that we cannot send event_name for the install conversions.
Example offerwall page
You can open a working offerwall to see how the page behaves before you integrate it:
The live demo is hosted by AppsPrize and loads only when you choose to. Nothing third-party is requested until you press the button.