Sticker Search

Sticker Search API는 사용자가 스티커를 검색 할 수 있는 기능입니다. 감정, 상황, 캐릭터 등 다양한 검색 태그를 입력해 검색 할 수 있으며 검색 결과는 앱의 카테고리와 사용자 위치 정보(언어와 국가)를 통해 자동으로 최적화됩니다. 이를 통해 사용자들이 꼭 필요로 하는 스티커를 제공 할 수 있습니다.

아래의 Best Practices 가이드를 따라 개발하면 사용자들에게 최적의 스티커 서비스를 제공 할 수 있습니다. 개발 완료 후에는 스티팝 대시보드에서 스티커 사용 통계를 볼 수 있으며 필터 등을 통해 직접 스티커를 관리 할 수도 있습니다.

Request URL

GET

https://messenger.stipop.io/v1/search

Best Practices

권장: 최적의 서비스를 위해 언어(lang)와 국가(countryCode) 파라미터를 사용해 사용자 위치 정보를 제공하세요. 스티팝은 사용자의 선호 언어, 문화, 그리고 로컬 트렌드를 적용해 자동으로 최적화된 스티커를 제공합니다. 언어와 국가의 기본값은 각각 en과 US 입니다.
권장: 사용자가 메신저 인터페이스에서 스티커를 사용 할 때 Register Sticker Send API를 사용해 스티커 전송 기록을 저장하세요.저장된 전송 데이터를 통해 향후 사용자들에게 제공되는 스티커가 보다 최적화 될 수 있으며 사용 데이터를 직접 확인 할 수도 있습니다.
검색과 연관된 다음 API endpoint도 사용해보세요: Trending Search Terms, Recent Search. 스티커 검색 최적화 가이드에서 더 상세한 내용도 확인 할 수 있습니다.
userId 파라미터에 다양한 사용자에 대해 같은 userId 값을 사용하지마세요. 해당 값은 지속적으로 모니터링이 되며 중복값이 사용 될 경우 API key가 비활성화 될 수 있습니다. userId 값은 아무 string 형태의 값이면 됩니다.
limit과 pageNumber 파라미터를 사용해 스티커 로딩 속도를 최적화하세요. 예를 들어 limit을 '30'으로 두고 pageNumber 1,2,3...을 적용해 한 페이지 (혹은 한 로딩)에 30개의 스티커를 보여주세요.
스티커 이미지 url에 dimension (d)을 추가해 이미지 사이즈 및 파일 크기를 최적화 할 수 있습니다. 다음과 같이 사용하실 수 있습니다: d=100x100 혹은 d=300x300 (단위: pixel). 권장드리는 기본 스티커 사이즈는 300px 이며 최대 크기는 700px 입니다.

Parameters

Request Headers
Required	Type	Description
apikey	string	발급받은 API 키 값: 스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.

Request Query Parameters
Required	Type	Description
q	string	검색어 혹은 문장. 40+개 언어 지원. 예시: 안녕, 야구, Excited, Merry Christmas
userId	string	앱 사용자에게 부여되는 고유 값. userId는 아무 string 값이면 됩니다. 중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
Strongly Recommended	Type	Description
lang	string	언어 최적화를 위해 언어 정보를 입력해주세요. ISO 639-1의 2-letter 언어 코드를 사용하세요. 기본 값: en
countryCode	string	국가 최적화를 위해 국가 정보를 입력해주세요. ISO 3166-1의 2-letter 국가 코드를 사용하세요. 기본 값: US
Optional	Type	Description
limit	int	페이지 당 보여줄 스티커 수 제한. pageNumber를 사용해 스티커 뷰를 최적화하세요. 기본 값: 20 (최대: 50)
pageNumber	int	pageNumber를 사용해 한 페이지 당 limit개수의 스티커를 보여주세요.

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/search?userId=9937&q=cute&lang=en&pageNumber=1&limit=10" --header "apikey:xxxxxxxxx"

Success Response

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
{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
      "stickerList": [
        {
          "stickerId": 51229,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50899,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50898,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        ................
      ],
      "pageMap": {
        "pageNumber": 1,
        "onePageCountRow": 10,
        "totalCount": 80,
        "pageCount": 8,
        "groupCount": 1,
        "groupNumber": 0,
        "pageGroupCount": 10,
        "startPage": 1,
        "endPage": 8,
        "startRow": 0,
        "endRow": 10,
        "modNum": 10,
        "listStartNumber": 80
      }
    }
}

Response Format

Attributes
Name	Type	Description
stickerId	int	스티커 ID
keyword	string	검색 태그
packageName	string	스티커 팩 이름
stickerImg	string	스티커 이미지 url

Error Response

Error	Code	Description
non exist apikey	9000	사용된 API 키가 존재하지 않습니다.
server error	1000	서버에서 정보를 받을 수 없습니다.

이 페이지가 도움이 되셨나요?

도움이 필요하신가요? 문의주세요.

Back

TutorialsPAID STICKER STORE GUIDE

SearchTRENDING SEARCH TERMS