Stipop Docs | Documentation for SDK and API

Sticker Curation Cards

Use the following Sticker Card APIs to create a unique and fully featured sticker store. Every sticker cards are curated by Stipop Content Team on a weekly basis, grouping trending sticker packs into themes, occasions, characters, and so on. Adding Sticker Cards and Main Sticker Banner will make the sticker browsing experience rich and fun for the users.

Each card numbers corresponds to different themes. For example, Sticker Card 1 is 'This week's popular stickers'. You can find more about how to utilize sticker cards in the tutorial for Sticker Store UI Options.

Request URL

GET
https://messenger.stipop.io/v1/curation/card/1
GET
https://messenger.stipop.io/v1/curation/card/2
GET
https://messenger.stipop.io/v1/curation/card/3
GET
https://messenger.stipop.io/v1/curation/card/4
GET
https://messenger.stipop.io/v1/curation/card/5
GET
https://messenger.stipop.io/v1/curation/card/6
GET
https://messenger.stipop.io/v1/curation/card/7

Best Practices

  1. Use the language and country parameters (strongly recommended) to provide user locale information for best use. Stipop automatically tunes the sticker content so that it matches your users' language preferences, cultures, and local trends. The default values for language and country are en and US.
  2. 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.
  3. Use the limit parameter to have optimal sticker card loading. For example, set limit to '10' to show 10 main cards.
  4. When a user sends sticker on any chat interface, you should Register Sticker Send. This is strongly recommended so that Stipop can analyze sticker send data to show most opt sticker pack list in the future.
  5. When a user downloads a sticker pack, you need to call the Download/Purchase Sticker API. You'll be needing this information when using APIs like My Sticker Packs, Download/Purchase History, and Recently Viewed Packs which are all essential features.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
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.
Strongly RecommendedTypeDescription
langstringSpecify default language for regional stickers.
Use a 2-letter ISO 639-1 language code.
Default Value: en
countryCodestringSpecify default country for local stickers.
Use a 2-letter ISO 3166-1 country code.
Default Value: US
OptionalTypeDescription
limitintThe maximum number of sticker cards.
Default Value: 10 (max: 16)

Example Request

Sample Call: Sticker Curation Cards
1
curl --location --request GET "https://messenger.stipop.io/v1/curation/card/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

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "cardInfo": [
      {
        "cardId": 1,
        "cardTitle": "This week's popular stickers",
        "cardType": 1,
        "cardImgUrl": null,
        "packageList": [
          {
            "packageId": 118,
            "packageName": "Stuart",
            "artistName": "MightyCat",
            "packageImg": "https://img.s....in_7.png",
            "tags": null
          }
        ]
      }
    ]
  }
}

Response Format

Attributes
NameTypeDescription
cardIdstringCard ID
cardTitlestringCard title (ex. This month's best stickers)
cardTypestringCard type (ex. 1, 2, 3. etc.)
cardImgUrlstringCard image
packageListListList of stickers within the sticker package
packageIdstringSticker package ID
packageNameintSticker package name
artistNamestringName of the artist
packageImgstringMain image of sticker package
packageKeywordsstringSticker package keyword
tagsstringSticker tag

Error Response

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