Download/Purchase Sticker
Users can download a sticker package to send it’s stickers on your messaging platform. Use the Download/Purchase Sticker API to activate sticker downloads and purchases. The default setting in your Dashboard is set to have the API used for sticker free downloads for users. You can follow these steps and start selling sticker packages on your platform and generate a new source of revenue. Many of our partners have utilized sticker stores in their app using our optimized UI Kit for Sticker Download/Purchase.
Each stickers in a pack have a file size less than 500KB and is also optimized so that it offers the most seamless user experience. The default file format of stickers are PNG and GIF for statis and animated stickers, respectively. You can find more about the sticker file formats and how these stickers are collected in our Sticker Guide.
Try applying this API when a user clicks either the ‘Download’ or ‘Purchase’ button on your app and you are almost done.
Request URL
Best Practices
- Decide whether you want to provide the stickers for free or sell them to your users. If you are unsure, you can always start with the free version and update it later on your Dashboard.
- Use the ‘price’ attribute when displaying the action/price button on your app so that you don’t have to change them again when you are switching from free model to a store model.
- You’ll be able to monitor the number of sticker downloads/purchases on your Dashboard Overview. We’ll let you know how to optimize the pricing model further on so that you can maximize the benefits.
Parameters
| Required | Type | Description |
|---|---|---|
| apikey | string | Stipop API Key for your app. Visit developer dashboard for new API Key. |
| Required | Type | Description |
|---|---|---|
| packId | string | The [packId] of a sticker pack, NOT stickerId. Example: 6363, 5636, 5859 |
| Required | Type | Description |
|---|---|---|
| userId | string | Unique value for every user to distinguish unique users. The userId can be in any string format. Important: Using same userId for multiple users is not allowed. |
| isPurchase | string | Free Sticker Store: Set isPurchase as N. Paid Sticker Store: Set isPurchase as Y. Sticker Subscription: Set isPurchase as S. Important: You must use the correct value depending on the sticker pricing model you apply on your app and service. If you set the value as Y or S, according revenue share will be made through your billing account on Dashboard. See tutorial for paid sticker store and subscription for more detail. Warning: If isPurchase is found to be using the wrong value, your API call can be blocked from usage. |
| Strongly Recommended | Type | Description |
|---|---|---|
| lang | string | Specify default language for regional search terms. Use a 2-letter ISO 639-1 language code. Default Value: en |
| countryCode | string | Specify default country for local search terms. Use a 2-letter ISO 3166-1 country code. Default Value: US |
| price | string | If isPurchase is Y, the default price is set for stickers. Default Price: Still Stickers [$0.99], Animated Stickers [$1.99] Or you can use the price to customize sticker price. |
Example Request
1
curl --location --request POST "https://messenger.stipop.io/v1/download/118?userId=9937&isPurchase=N" --header "apikey:xxxxxxxxx"Success Response
1
2
3
4
5
6
7
8
{
header: {
code: '0000',
status: 'success',
message: 'success',
},
body: [],
}
Warning Response:
| Error | Type | Description |
|---|---|---|
| Duplicate download | 0000 | The user has already downloaded the sticker package |
Error Response
| Error | Code | Description |
|---|---|---|
| non exist apikey | 9000 | The API key used does not exist |
| server error | 1000 | Unable to receive data from the server |
Back