Stipop Docs | Documentation for SDK and API

Sticker Pack Info

Sticker Pack Info API는 스티커 팩에 대한 모든 이미지 및 필수 정보를 불러와 스티커 팩 페이지를 구성할 수 있습니다. 스티커 팩 페이지에는 스티커 작가 이름을 보여주어 저작권 관련 이슈를 사전에 방지하는 것이 좋습니다. 해당 API를 사용해 사용자가 인기 스티커 팩 목록에서 스티커를 클릭 할 때 넘어가지는 스티커 팩 페이지를 만들어보세요.

Request URL

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

Best Practices

  1. userId 파라미터에 다양한 사용자에 대해 같은 userId 값을 사용하지마세요. 해당 값은 지속적으로 모니터링이 되며 중복값이 사용 될 경우 API key가 비활성화 될 수 있습니다. userId 값은 아무 string 형태의 값이면 됩니다.
  2. API 요청에 대한 결과 (attributes)로 넘어오는 스티커 팩 이름 및 작가 이름 등을 사용해 스티커 팩 페이지를 구성하세요.

Parameters

Request Headers
RequiredTypeDescription
apikeystring발급받은 API 키 값:
스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.
Request Path Parameters
RequiredTypeDescription
packIdstring스티커 팩의 [packId]이며 개별 스티커의 stickerId 와는 다릅니다.
예시: 6363, 5636, 5859
Request Query Parameters
RequiredTypeDescription
userIdstring앱 사용자에게 부여되는 고유 값.
userId는 아무 string 값이면 됩니다.
중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.

Example Request

샘플 요청: 스티커 팹 상세 정보
1
curl --location --request GET "https://messenger.stipop.io/v1/package/5636?userId=xxx" --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
{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
      "package": {
        "packageId": 118,                      
        "artistName": "MightyCat",            
        "packageName": "Stuart",                
        "packageImg": "https://img....png",   
        "packageAnimated": "N",                
        "packageCategory": "Animation/Cartoon", 
        "packageKeywords": "Stuart,Sticker",    
        "isNew": "N",                           
        "language": "English",                  
        "isDownload": "Y",                            
        "isWish": "N",					
        "stickers": [                          
            {
                "stickerId": 790,              
                "packageId": 118,               
                "stickerImg": "https://img...._5_2.png" 
            },
            {
                "stickerId": 791,
                "packageId": 118,
                "stickerImg": "https://img....._6_1.png"
            }
            ......
        ]
    }
  }
}

Response Format

Attributes
NameTypeDescription
packageIdint스티커 팩 ID
packageNamestring스티커 팩 이름
packageImgstring스티커 팩 메인 이미지
packageCategorystring스티커 팩 카테고리
packageKeywordsstring스티커 팩 키워드
packageAnimatedstring스티커 팩 애니메이션 유무 (Y/N)
isNewstring새로운 스티커 팩 (Y/N)
artistNamestring스티커 팩 작가 이름
languagestring스티커 팩 메인 언어
isDownloadstring스티커 팩 사용자 다운로드 여부 (Y/N)
isWishstring스티커 팩 사용자 위시 리스트 여부 (Y/N)
stickersstringList of stickers within the sticker package
stickerIdint스티커 ID
stickerImgstring스티커 이미지 url

Error Response

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