Camera Sticker Info
The Camera Sticker Info API contains all the sticker images and package information you need to display a sticker package page. It is important that sticker artist’s name is displayed on this page to prevent any copyright issues.
Check the UI Kit for a sticker package page to get more understanding of how this API can be used. The sticker package page is needed whenever user clicks to see a certain sticker package and to download or purchase a sticker package.
Request URL
GET
https://camera.stipop.io/v1/package/:packageId
Best Practices
- Check all the components that can be put into a sticker package page from our UI Kit. It will help you build the sticker feature much quicker and easier.
- We recommend you using the sticker name, artist name along with all sticker images when building the sticker package page.
- Try using all of the parameters to provide high-success rate sticker ranking list. We highly recommend you using the language, country, category, and searchText parameters.
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. |
Example Request
Sample call for all sticker info of a sticker package
cURL
1
curl --location --request GET "https://camera.stipop.io/v1/package/1?userId=xxx" --header "apikey:xxxxxxxxx"
Success Response
Success Response code 200
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
"header": {
"code": "0000",
"status": "success",
"message": "success"
},
"body": {
"package": {
"packageId": 118,
"artistName": "MightyCat",
"packageName": "Stuart",
"packageImg": "https://img....png",
"packageAnimated": "N",
"packageCategory": "Animation/Cartoon",
"packageKeywords": "Stuart,Sticker",
"isNew": "N",
"language": "English",
"stickers": [
{
"stickerId": 790,
"packageId": 118,
"stickerImg": "https://img...._5_2.png"
},
{
"stickerId": 791,
"packageId": 118,
"stickerImg": "https://img....._6_1.png"
}
......
]
}
}
}
Response Format
Name | Type | Description |
---|---|---|
packageId | string | Sticker package ID |
packageName | int | Sticker package name |
packageImg | string | Main image of sticker package |
packageCategory | int | Sticker package category |
packageKeywords | string | Sticker package keyword |
packageAnimated | int | Is sticker animated (Y/N) |
isNew | string | Is sticker new (Y/N) |
artistName | int | Name of the artist |
language | string | Main language of sticker package |
stickers | string | List of stickers within the sticker package |
stickerId | string | Sticker ID |
stickerImg | string | Sticker image url |
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 |
Was this page helpful?
We’re here to help. Contact us.