Stipop Docs | Documentation for SDK and API

Getting Best Stickers

서비스에 베스트 스티커 팩 목록을 추가하는 것으로 시작해보세요. Package Ranking List API를 사용하여 스티팝 플랫폼에서 수 백만 건의 스티커 다운로드 데이터를 기반으로 한 상위 랭킹 스티커 팩를 사용 할 수 있습니다. 사용자에게 스티커 팩 목록을 보여줄 때 가장 일반적으로 사용하는 API 입니다.

스티커 팩는 총 15-24개의 스티커로 구성되어 있으며 팩 이름, 카테고리, 키워드 및 언어 정보와 같은 추가 정보가 포함되어 있습니다. 스티커 기능을 구현할 때에는 좌측 메뉴에 있는 Endpoints에서 다양한 endpoint를 활용하는 것을 추천드립니다. 단 몇 가지의 API 연동을 통해 다양한 스티커와 서비스를 제공하는 스티커 기능을 구현할 수 있습니다.

빠른 시작을 위해 다음 Package Ranking List API 를 사용해 공통 언어와 일반 산업 분야에 적용되는 상위 200개 스티커 팩 목록을 호출 해보겠습니다. 다음은 기능을 최대로 구현하는데 도움이 되는 몇 가지 가이드입니다.

Request URL

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

Best Practices

  1. 운영하고 있는 서비스의 타겟 사용자 정보를 정의하세요. 예를 들어 미국에 거주하면서 스페인어를 사용하는 사용자 혹은 인도에 거주하면서 영어를 사용하는 사용자가 될 수 있습니다.
  2. 스티팝 대시보드에 가입하고 새로운 앱을 생성해 unique API 키를 발급받으세요. 새로운 앱을 생성할때는 원하는 API 제품을 선택하고 산업에 대한 기본 정보를 제공하시면 스티팝 스마트 스티커 추천을 통해 최적화된 스티커 목록을 받아보실 수 있습니다.
  3. 모든 매개 변수를 사용하여 성공률이 높은 스티커 랭크 목록을 제공하세요. Language, country, category, 그리고 searchText 매개 변수를 사용하시는 것을 추천드립니다.

Parameters

Request Headers
RequiredTypeDescription
apikeystring발급받은 API 키 값:
스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.
Request Query Parameters
RequiredTypeDescription
userIdstring앱 사용자에게 부여되는 고유 값.
userId는 아무 string 값이면 됩니다.
중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
OptionalTypeDescription
pageNumberint페이지 번호
datestring랭킹 기간 - 예) Daily, Weekly, Monthly
비어있는 매개 변수: 전체 기간
categorystringCategory Endpoint에서 확인되는 카테고리 중 선택된 카테고리만 제공
animatedstringY: 움직이는 스티커 랭킹 조회
N: 안움직이는 스티커 랭킹 조회
비어있는 매개 변수: 모든 스티커 랭킹 조회
countryCodestring국가 최적화를 위해 국가 정보를 입력해주세요.
ISO 3166-1의 2-letter 국가 코드를 사용하세요.
기본 값: US
searchTextstring검색 키워드

Example Request

언어가 영어로 설정 된 스티커 순위 리스트 요청 예시
1
curl --location --request GET "https://messenger.stipop.io/v1/package?userId=xxx&pageNumber=1&country=kr" --header "apikey:xxxxxxxxx"

Success Response

성공 응답: 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
{
  header: {
    code: '0000',
    status: 'success',
    message: 'success',
  },
  body: {
    packageList: [
      {
        packageId: 2309,
        packageName: 'cada día',
        packageImg: 'https://img....70AAeHBn4N.png',
        packageCategory: 'Animation/Cartoon,Gag',
        packageKeywords: 'bonito,mono,bello,adorable,life,cute,lovely',
        packageAnimated: 'N',
        isNew: 'N',
        artistName: 'pinono',
        language: 'Spanish',
        isDownload: 'Y',
        isWish: 'N',
      },
      {
        packageId: 2473,
        packageName: '¿Cómo estás?',
        packageImg: 'https://img.....Ggdu7s3J15.gif',
        packageCategory: 'Phrases,Etc.',
        packageKeywords: '¿Cómoestás?,letra',
        packageAnimated: 'Y',
        isNew: 'N',
        artistName: 'annapig',
        language: 'Spanish',
        isDownload: 'Y',
        isWish: 'N',
      },
    },
  },
}

Response Format

Attributes
NameTypeDescription
packageIdint스티커 팩 ID
packageNamestring스티커 팩 이름
packageImgstring스티커 팩의 메인 이미지
packageCategoryint스티커 팩의 카테고리
packageKeywordsstring스티커 팩의 키워드
packageAnimatedint움직이는 스티커 여부 (Y/N)
isNewstring새로운 스티커 여부 (Y/N)
artistNameint스티커 작가 이름
languagestring스티커 팩의 메인 언어
isDownloadstring사용자의 스티커 다운로드 여부 (Y/N)
isWishstring스티커 위시리스트 여부 (Y/N)

Error Response

ErrorCodeDescription
non exist apikey9000사용된 API 키가 존재하지 않습니다.
server error1000서버에서 정보를 받을 수 없습니다.
도움이 필요하신가요? 문의주세요.