Quick Integration
To start using the Web SDK, redirect your users or embed the following URL:
https://web.appsprize.com/?token=<TOKEN>&user_id=<USER_ID>&country_code=<COUNTRY_CODE>&language=<LANGUAGE>&platform=<PLATFORM>&ad_id=<AD_ID>
You only need to replace the mandatory parameter placeholders (<TOKEN>, <USER_ID>, etc.) with actual values specific to the user and your integration. You need to use the token where you get from your dashboard in the app you added. For the dashboard access please visit https://dashboard.appsprize.com/register and register for an account. After you add your app, please select the platform as iOS.
Request Parameters
| Parameter | Format | Description | Type |
|---|---|---|---|
| token | String | Your app token. Used to validate and authorize the session. | Mandatory |
| user_id | String | Unique identifier of the current user in your system. | Mandatory |
| ad_id | String | Device identifier used for tracking or attribution. | Recommended |
| country_code | String | 2-letter ISO country code (e.g., UK, US). | Mandatory |
| language | String | 2-letter ISO language code (e.g., en, tr). | Mandatory |
| platform | String | Platform identifier. (e.g., ios, web) | Recommended |
Example URL
Here is an example of a fully functional Web SDK URL:
https://web.appsprize.com/?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6M30.p9TEgKWSZXFpyFs9GQ-B8EAi6lfeyycTUnqlNgaYZvA&user_id=3&country_code=US&language=en&platform=ios&ad_id=1111-1111-1111-1111111-111
You can generate this URL dynamically for each user in your backend.
Integration Options
1. Redirect (Full Page)
Redirect users directly to the Web SDK using JavaScript:
window.location.href = "https://web.appsprize.com/?token=...&user_id=...&country_code=...&language=...";2. Embedded (iframe)
To embed the experience within your own page:
<iframe
src="https://web.appsprize.com/?token=...&user_id=...&country_code=...&language=..."
width="100%"
height="100%"
style="border: none;">
</iframe>We recommend responsive containers or fixed dimensions based on your UI.
Best Practices
- Always use unique user_id values per user to ensure correct tracking.
- Keep your token secure. Do not expose long-lived tokens in public repositories.
- Validate that country_code and language reflect the user’s current locale for a localized experience.
Server-to-Server Payout
To enable users to claim their accumulated rewards, they need to receive a payout. Each reward can be redeemed only once.
To utilize server-to-server payout, you should establish an endpoint on your server, which we can trigger to inform you about the install and user's rewards. Upon receiving this notification, the responsibility of delivering the rewards to the user lies with you.
We strongly advise adopting the server-to-server payout method for rewards due to its enhanced security and improved transparency on your side.
Endpoint Structure
Once you share your endpoint URL, we will use HTTP POST to send the callback. We will include the following parameters:
| Parameter | Description | Format | Type |
|---|---|---|---|
| user_id | Unique client app's user ID | string | mandatory |
| coin_currency | currency name of client app | string | mandatory |
| coin_amount | Total number of reward amount that will be earned by the users when they completed whole levels | float | mandatory |
| cpi_bid | offer cpi/cpa bid | float | mandatory |
| payout_currency | currency of offer cpi bid (USD) | string | mandatory |
| device_id | advertising ID of end-user from install | string | optional |
| trans_id | The unique transaction ID | UUID v4 | mandatory |
| sig | Signature that should be verified request authenticity. It's a SHA256 hash code of the calculation of the request parameters as sig=SHA256(concatenate(trans_id,user_id,coin_amount,coin_currency ,app_token,s2s_token) | string | mandatory |
| event_name | Exact event name coming from advertiser/offer's app | string | mandatory |
| event_token | Event description | string | mandatory |
| event_coin_amount | The reward amount that will be earned by the users when they completed an event/task. | float | mandatory |
| app_bundle_id | Advertiser/offer's app bundle id | string | optional |
| app_name | Advertiser/offer's app name | string | optional |
| currency | Publisher Currency Name | string | optional |
In order to be ensure that the callback requests are coming from us, you need to calculate the sig parameter and compare with the parameters which are sent by the callback request. Calculation is; sig=SHA256(concatenate(trans_id,user_id,coin_amount,coin_currency ,app_token,s2s_token).
Once you share your endpoint, a unique s2s_token will be generated and sent to you.
We will make POST requests whenever a user installs and opens the app, or completes a event.
Sample Body for Install Request
{
"app_bundle_id": "com.oakgames.linked2248.numberpuzzle",
"app_name": "2248: Number Puzzle Game",
"coin_amount": 10000,
"coin_currency": "USD",
"cpi_bid": 0.15,
"sig": "5d775fa8d601ffdea8a65fd0225e0637d2b87b57072483dd0dcc49aa735c9b", // (trans_id, user_id, coin_amount, coin_currency, app_token, s2s_token)
"trans_id": "36097a85-5e1b-44b6-8966-0e2e226b7a0",
"type": "install",
"user_id": "test1"
}Sample Body for In-app Events/Tasks
{
"app_bundle_id": "com.sport.cornhole",
"app_name": "Cornhole League",
"coin_amount": 10000,
"coin_currency": "USD",
"cpi_bid": 9,
"event_coin_amount": 27000,
"event_name": "Level_5",
"event_token": "Reach Level 5",
"sig": "a65d72b215160e643058659089558c6d35c55717277b33c6becd7e403bfd31fb",
"trans_id": "70660187-93cf-40eb-8cce-f9ce22fc46e2",
"type": "event",
"user_id": "test1"
}For some offers, we can add additional special offer section such as in-app purchase events, in this situation we will send postback with
"cpi_bid":0. Only you need to useevent_coin_amountin these requests in order to reward the user.
Need Help?
For integration support or feedback, reach out to your AppsPrize technical account manager.
Updated 4 days ago