Stipop Docs | Documentation for SDK and API

Download/Purchase History

Download/Purchase History API는 사용자가 구매 혹은 다운로드 한 스티커 팩 목록을 제공합니다. 해당 API를 통해 사용자의 구매 혹은 다운로드 스티커 팩 목록을 마이페이지 UI에 구현할 수 있습니다. 이 기능은 사용자에게 필수적으로 제공되어야 하는 매우 중요한 기능입니다. 다운로드 스티커 팩 목록은 대시보드 설정에서 유료 스티커 스토어로 상태를 바꾸고 스티커 가격 정보를 입력하면 자동으로 구매 스티커 팩 목록으로 업데이트됩니다. 무료 스티커 모델에서 유료 스티커 스토어로 변경하는 방법에 대해서는 이 페이지를 참고해주세요.

이 기능과 관련된 UI Kit를 확인하면 보다 쉽게 기능을 구현할 수 있습니다.

Request URL

GET
https://messenger.stipop.io/v1/download/:userId

Best Practices

  1. 해당 API를 활용하기 위해 사용자가 스티커 팩을 다운로드 할 시 Download/Purchase Sticker API를 꼭 사용해 다운로드 기록을 남겨주세요.
  2. userId 파라미터에 다양한 사용자에 대해 같은 userId 값을 사용하지마세요. 해당 값은 지속적으로 모니터링이 되며 중복값이 사용 될 경우 API key가 비활성화 될 수 있습니다. userId 값은 아무 string 형태의 값이면 됩니다.
  3. limit과 pageNumber 파라미터를 사용해 스티커 로딩 속도를 최적화하세요. 예를 들어 limit을 '30'으로 두고 pageNumber 1,2,3...을 적용해 한 페이지 (혹은 한 로딩)에 30개의 스티커를 보여주세요.
  4. 스티커 이미지 url에 dimension (d)을 추가해 이미지 사이즈 및 파일 크기를 최적화 할 수 있습니다. 다음과 같이 사용하실 수 있습니다: d=100x100 혹은 d=300x300 (단위: pixel). 권장드리는 기본 스티커 사이즈는 300px 이며 최대 크기는 700px 입니다.

Parameters

Request Headers
RequiredTypeDescription
apikeystring발급받은 API 키 값:
스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.
Request Query Parameters
RequiredTypeDescription
userIdstring앱 사용자에게 부여되는 고유 값.
userId는 아무 string 값이면 됩니다.
중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
OptionalTypeDescription
limitint페이지 당 보여줄 스티커 수 제한.
pageNumber를 사용해 스티커 뷰를 최적화하세요.
기본 값: 20 (최대: 50)
pageNumberintpageNumber를 사용해 한 페이지 당 limit개수의 스티커를 보여주세요.

Example Request

샘플 요청: 구매 및 다운로드 내역
1
curl --location --request GET "https://messenger.stipop.io/v1/download/9937"  --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
{
  header: {
    code: '0000',
    status: 'success',
    message: 'success',
  },
  body: {
    packageList: [
      {
        packageId: 118,
        packageName: 'Stuart',
        packageImg: 'https://img...._7.png',
        packageCategory: 'Animation/Cartoon',
        packageKeywords: 'Stuart,Sticker',
        packageAnimated: 'N',
        isNew: 'N',
        artistName: 'MightyCat',
        language: 'English',
        isDownload: 'Y',
        isWish: 'N',
      },
    ],
  },
}

Response Format

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

Error Response

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