Web SDK Quick Integration

To start using the Web SDK, redirect your users to the following URL or embed it:

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 swap the mandatory placeholders (<TOKEN>, <USER_ID> and so on) for values specific to the user and to your integration. The token comes from your dashboard, against the app you added there. To get dashboard access, register at dashboard.appsprize.com/register. After you add your app, 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

A fully formed Web SDK URL looks like this:

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

Generate this URL on your backend, per user.

Integration options

1. Redirect (full page)

Send users straight to the Web SDK from JavaScript:

JavaScript

window.location.href = "https://web.appsprize.com/?token=...&user_id=...&country_code=...&language=...";

2. Embedded (iframe)

To run the experience inside your own page:

HTML

<iframe
  src="https://web.appsprize.com/?token=...&user_id=...&country_code=...&language=..."
  width="100%"
  height="100%"
  style="border: none;">
</iframe>

Use a responsive container, or fixed dimensions that suit your interface.

Best practices

Always use a unique user_id per user so tracking stays correct.
Keep your token secure. Do not expose long-lived tokens in public repositories.
Make sure country_code and language reflect the user's current locale, so they get a localized experience.

Server-to-server payout

Users claim what they have accumulated through a payout, and each reward can only be redeemed once.

To use server-to-server payout, stand up an endpoint on your server that we can call to tell you about the install and the user's rewards. Once you receive that notification, delivering the reward to the user is your responsibility.

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 send the callback with HTTP POST, including these 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
`type`	Type of Postback Request (install or event)	string	mandatory

To confirm that a callback genuinely came from us, calculate the sig parameter yourself and compare it against the one in the request. The calculation is sig=SHA256(concatenate(trans_id,user_id,coin_amount,coin_currency ,app_token,s2s_token).

Once you share your endpoint, we generate a unique s2s_token and send it to you.

We will make POST requests whenever a user installs and opens the app, or completes a event.

Sample body for an install request

JSON

{
  "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 and tasks

JSON

{
  "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 use event_coin_amount in these requests in order to reward the user.

The HTTP 200 OK successful response status code indicates that a request has succeeded.

Need help?

For integration support or feedback, reach out to your AppsPrize technical account manager.