My Sticker Package List
My Sticker Package List API는 사용자가 구매하거나 다운로드 받은 스티커 팩 목록을 제공합니다. 해당 API를 통해 사용자가 보유한 스티커 팩 목록을 마이페이지 UI에 구현할 수 있습니다. 대시보드의 무료/유료 스티커 설정에 따라 자동으로 다운로드 목록 혹은 구매 목록으로 사용할 수 있습니다. 무료 스티커 모델에서 유료 스티커 스토어로 변경하는 방법에 대해서는 이 페이지를 참고해주세요.
이 기능과 관련된 UI Kit를 확인하면 보다 쉽게 기능을 구현할 수 있습니다.
Request URL
GET
https://messenger.stipop.io/v1/mysticker/:userId
Best Practices
- My Sticker Pack API를 활용하기 위해서는 사용자가 스티커 팩을 다운로드 할 시 다음 Download/Purchase Sticker API를 꼭 사용해 다운로드 기록을 남겨주세요. 추가적으로 Download/Purchase History 와 Recently Viewed Packs를 함께 사용할 수 있습니다.
- 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
| Required | Type | Description |
|---|---|---|
| apikey | string | 발급받은 API 키 값: 스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다. |
| Required | Type | Description |
|---|---|---|
| userId | string | 앱 사용자에게 부여되는 고유 값. userId는 아무 string 값이면 됩니다. 중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다. |
| Optional | Type | Description |
| limit | int | 페이지 당 보여줄 스티커 수 제한. pageNumber를 사용해 스티커 뷰를 최적화하세요. 기본 값: 20 (최대: 50) |
| pageNumber | int | pageNumber를 사용해 한 페이지 당 limit개수의 스티커를 보여주세요. |
Example Request
샘플 요청: 내 스티커 리스트
cURL
1
curl --location --request GET "https://messenger.stipop.io/v1/mysticker/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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
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',
isView: 'Y',
order: 1,
isNew: 'N',
artistName: 'MightyCat',
language: 'English',
isDownload: 'Y',
isWish: 'Y',
},
{
packageId: 119,
packageName: 'The Boy',
packageImg: 'https://img...png',
packageCategory: 'Animation/Cartoon',
packageKeywords: 'Boy,Sticker',
packageAnimated: 'N',
isView: 'Y',
order: 2,
isNew: 'N',
artistName: 'blueman_print',
language: 'English',
isDownload: 'Y',
isWish: 'N',
},
],
},
}
Response Format
| Name | Type | Description |
|---|---|---|
| packageId | int | 스티커 팩 ID |
| packageName | string | 스티커 팩 이름 |
| packageImg | string | 스티커 팩의 메인 이미지 |
| packageCategory | string | 스티커 팩의 카테고리 |
| packageKeywords | string | 스티커 팩의 키워드 |
| packageAnimated | string | 움직이는 스티커 여부 (Y/N) |
| isNew | string | 새로운 스티커 여부 (Y/N) |
| artistName | string | 스티커 작가 이름 |
| language | string | 스티커 팩의 메인 언어 |
| isDownload | string | 사용자의 스티커 다운로드 여부 (Y/N) |
| isWish | string | 스티커 위시리스트 여부 (Y/N) |
| isView | string | 스티커 조회 여부 (Y/N) |
| order | int | 보유한 스티커 팩 목록의 순서 |
Error Response
| Error | Code | Description |
|---|---|---|
| non exist apikey | 9000 | 사용된 API 키가 존재하지 않습니다. |
| server error | 1000 | 서버에서 정보를 받을 수 없습니다. |
이 페이지가 도움이 되셨나요?
도움이 필요하신가요? 문의주세요.
Back