Stipop Docs | Documentation for SDK and API

Getting Camera Stickers

Here's a quick way to start integrating camera stickers to your app or website. The Camera Sticker List API delivers over 250,000 stickers that are suitable for any video/camera UI like video call and live streaming. Stickers include both animated and still stickers, each uniquely designed by artists around the world.

Stickers usually come in packages and a sticker package consists of 15-24 stickers with additional information such as the package name, category, keyword, and the main language. We recommend you use different sets of specific endpoints from the Endpoints section on the left. With just a several integraions you’ll be able to supply a variety of sticker packages with multiple features.

Request URL

GET
https://camera.stipop.io/v1/package

Best Practices

  1. Define the demographics of your target users. For example, users living in the United States speaking Spanish or users living in India speaking English and so on.
  2. Sign up in the Dashboard and create an application to get a unique API key. When creating a new application, select products you want to implement and provide industry and market information so you can benefit from Stipop smart sticker curation feature which automatically provides the ideal stickers to your app.
  3. 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

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.
OptionalTypeDescription
pageNumberintPage number
datestringRanking period
Ex) Daily, Weekly, Monthly

Empty parameter: Total period
categorystringShow results only for category chosen from the Category Endpoint
animatedstringY: Look for animated sticker ranking
N: Look for static(still) sticker ranking
Empty parameter: Look for all stickers
countrystringTwo letter code for selecing country in ranking
Ex) en, ko, es
searchTextstringSearch keyword

Example Request

Sample call for a list of camera stickers
1
curl --location --request GET "https://camera.stipop.io/v1/package?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
36
37
38
39
40
41
42
43
44

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "packageList": [
      {
        "packageId": 5445,
        "packageName": "Cute blue cat",
        "packageImg": "https://img.....128_1.png",
        "packageCategory": "Animation/Cartoon,Etc.",
        "packageKeywords": "cat",
        "packageAnimated": "N",
        "isNew": "Y",
        "artistName": "MightyCat",
        "language": "English",
        "onOff": "on",
        "lOrder": 1,
        "packageDate": "2020-12-28T05:35:37.000Z"
      },
      {
        "packageId": 5441,
        "packageName": "Lovely girlfriend",
        "packageImg": "https://img.....0FCi2.gif",
        "packageCategory": "Animation/Cartoon,Celebrity,People",
        "packageKeywords": "Cute,Fantasy,young,pretty,adorable,woman,sweetheart,doll,couple,marriage,wedding,healing,honeymoon,luck,angel,romance",
        "packageAnimated": "Y",
        "isNew": "N",
        "artistName": "andromarius",
        "language": "English",
        "onOff": "on",
        "lOrder": 1,
        "packageDate": "2020-10-12T13:53:00.000Z"
      },
      ....
    ],
    "pageMap": {
      ...
    }
  }
}

Response Format

Attributes
NameTypeDescription
stickerIdstringUnique value for a single sticker
stickerImgstringSticker image url

Error Response

ErrorCodeDescription
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
We’re here to help. Contact us.