Stipop Docs | Documentation for SDK and API

Sticker Pack Info

The Sticker Pack Info API contains all the sticker images and package information you need to display a sticker pack page. It is important that sticker artist’s name is displayed on this page to prevent any copyright issues. Use this API when a user clicks on a sticker pack from a trending/new sticker pack list to show sticker pack page.

Request URL

GET
https://messenger.stipop.io/v1/package/:packageId

Best Practices

  1. For the userId parameter, please don't use identical userId for multiple users. This is thoroughly monitored and in case of any misuse, the API key can be blocked from usage. The userId can be in any string format.
  2. Use attributes from a successful response like the pack name and aritst name to build a sticker pack page with full components.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Path Parameters
RequiredTypeDescription
packIdstringThe [packId] of a sticker pack, NOT stickerId.
Example: 6363, 5636, 5859
Request Query Parameters
RequiredTypeDescription
userIdstringUnique 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: Sticker Pack Info
1
curl --location --request GET "https://messenger.stipop.io/v1/package/5636?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
35
{
  "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",                  
        "isDownload": "Y",                            
        "isWish": "N",					
        "stickers": [                          
            {
                "stickerId": 790,              
                "packageId": 118,               
                "stickerImg": "https://img...._5_2.png" 
            },
            {
                "stickerId": 791,
                "packageId": 118,
                "stickerImg": "https://img....._6_1.png"
            }
            ......
        ]
    }
  }
}

Response Format

Attributes
NameTypeDescription
packageIdstringSticker package ID
packageNameintSticker package name
packageImgstringMain image of sticker package
packageCategoryintSticker package category
packageKeywordsstringSticker package keyword
packageAnimatedintIs sticker animated (Y/N)
isNewstringIs sticker new (Y/N)
artistNameintName of the artist
languagestringMain language of sticker package
isDownloadstringIs sticker downloaded by the user (Y/N)
isWishstringIs sticker in wish list (Y/N)
stickersstringList of stickers within the sticker package
stickerIdstringSticker ID
stickerImgstringSticker image url

Error Response

ErrorCodeDescription
non exist apikey9000The API key used does not exist
server error1000Unable to receive data from the server
We’re here to help.Contact us.