Intro •
Key Features •
Get Started •
Announcements •
Issues •
License
1. Package •
2. Download •
3. Analytics •
4. Common •
5. My Sticker •
6. Gift
스티팝 스티커 스토어 API를 통해 서비스에서 새로운 수익을 창출할 수 있습니다.
스티커는 가장 효과적이고 쉬운 감정표현이 가능합니다. 때문에 스티커는 온라인 이용자들에게 필수적인 요소입니다. 카카오톡에서만 사용되던 스티커를 당사 서비스에서 제공해보세요. 쉽고 빠른 설치를 통해 새로운 수익을 창출 할 수 있습니다. 저희는 스티커를 통해 이용자들이 온라인에서 더 효과적으로 커뮤니케이션 할 수 있도록 돕습니다.
아래 API 문서는 '스티커 스토어' 설치를 위한 문서입니다. 스티커 스토어가 아닌 '일반 스티커' 설치는 여기서 확인할 수 있습니다.
- 스티커 인기순위 조회
- Pricing plan에 따라 20~3,000 패키지 리스트 조회
- 키워드, 카테고리, 국가, 언어 등의 파라미터를 활용해 세밀한 스티커 리스트 조회 가능
- 총 25개국 5,000명의 작가가 디자인한 스티커
- 다양한 언어 제공
- English/Spanish/Hindi/Russian/German/French/Portuguese/Italian/Chinese/Catonese/Japanese/Thai/Indonesian/Korean
- 스티커 구매 정보
- 쉬운 스티커 판매 모델을 적용한 빠른 개발 및 유료 스티커 수익화
- 스티커 전송 통계
- 스티커 전송 통계를 통해 보다 세밀한 스티커 추천과 이를 통한 수익 극대화
아래 API Document를 통해 response 확인 및 서비스에 스티커 스토어를 적용할 수 있습니다. 개발 진행시 발생되는 에러/버그는 이슈에 등록해주시면 24시간 내로 응답됩니다. 새로 추가되는 업데이트는 하단 'Announcement'란에 명시됩니다. 추가 문의는 biz@stipop.io로 해주시기 바랍니다.
v0.1은 스티커 스토어 개발을 위한 기본 기능/스티커를 테스트 해볼 수 있는 버전입니다. 아래는 새로 추가된 기능입니다.
- 1.3 최근 조회한 스티커 팩
- 1.4 최근 전송한 스티커
- 1.5 자주 쓰는 스티커
- 5.1 위시리스트에 추가/삭제
- 5.2 위시리스트 조회
- 5.3 내 스티커 팩 목록 조회
- 5.4 숨긴 내 스티커 리스트
- 5.5 내 스티커 숨김 및 해제
- 6.1 선물 보내기
- 6.2 선물 받음 확인
- 6.3 보낸 선물 리스트
- 6.4 받은 선물 리스트
해당 Github Repository에 Bug 혹은 새로운 Feature 제안 Issue를 생성하실 수 있습니다. 기타 문의사항은 biz@stipop.io에 연락 부탁드립니다.
- Bug Report 생성하기
- Feature Request 생성하기
Base Url: https://bapi.stipop.io
Authentication: 스티팝 스토어 API는 API Key 인증을 통해 사용할 수 있습니다. API Key는 dashboard.stipop.io에서 회원가입 후 앱 별로 Unique API Key를 발급 받을 수 있습니다.
API Key는 중요한 정보이니 외부 노출이 되지 않도록 신경써주시기 바랍니다. 특히 Github, blog 등 오픈된 공간에 공유하지 마세요. Authentication은 HTTP Basic Auth를 통해 실행됩니다. API Key를 Basic Auth Username Value로 제공하시면 됩니다. Password는 제공하지 않으셔도 됩니다.
모든 API Request는 HTTPS를 통해 이뤄져야합니다. HTTP를 통한 Request는 작동하지 않습니다. 또한 Authentication이 되지 않은 Request 또한 작동하지 않습니다.
스티커 팩 인기순위 리스트는 적용된 Pricing Plan에 따라 20개 혹은 200개의 스티커를 불러올 수 있습니다. 스티팝에 업로드 된 모든 스티커는 전 세계 작가들이 제작한 스티커이며 승인되기 위해서는 스티팝 콘텐츠 가이드라인을 통과해야만 합니다. 디폴트로 적용된 인기순위는 스티팝 앱 내 데이터를 통해 정해진 순위이며 개발이 진행됨에 따라 당사 서비스 다운로드를 기준으로 순위가 정해질 수 있습니다.
-
URL
/v0.1/store/package
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Query Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값Not Required:
pageNumber=[int]페이지 번호language=[string]스티커 언어팩 ex) English, Spanish, Korean, German, French, Japanesedate=[string]인기순위 기간 ex) Daily, Weekly, Monthly 미입력시 전체순위category=[string]스티커 카테고리 x.x의 카테고리 조회후 검색animated=[string]Y: 움직이는 스티커 랭킹조회, N: 스티커 랭킹조회, 파라미터 미입력시 전체조회country=[string]국가별 랭킹 두자리 국가코드 입력 ex) kr, us, essearchText=[string]검색어 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "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" }, `......` ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/package?userId=xxx&pageNumber=1&country=kr" \ --header "apikey:xxxxxxxxx"
스티커는 팩으로 구성됩니다. 하나의 스티커 팩은 15~24개의 스티커를 가지고 있으며 스티커 팹 이름, 작가 정보, 스티커 정보, 대표 이미지 등으로 구성되어 있습니다. 스티커 팩 상세 API를 통해 스티커 페이지를 만들어보세요.
-
URL
/v0.1/store/package/:packageId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
packageId=[int]패키지 아이디 값 -
Request Query Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "package": { "packageId": 118, //패키지 아이디 "artistName": "MightyCat", //작가명 "packageName": "Stuart", //스티커 팩 이름 "packageImg": "https://img....png", //스티커 팩 대표 이미지 url "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" //스티커 이미지 url }, { "stickerId": 791, "packageId": 118, "stickerImg": "https://img....._6_1.png" } ...... ] } } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/package/118?userId=9937&" \ --header "apikey:xxxxxxxxx"
유저가 최근 조회한 스티커 팩 15개 리스트입니다. 최근 조회 스티커 팩을 보여줌으로써 구매 전환율을 높일 수 있습니다.
-
URL
/v0.1/store/package/recent/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "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" }, `......` ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/package/recent/9937" \ --header "apikey:xxxxxxxxx"
유저가 최근 전송한 스티커 15개 입니다. 해당 API는 스티커를 전송하는 키보드 섹션에 추가하면 유저가 최근 전송한 스티커를 편하게 다시 전송할 수 있게 도와줄 수 있습니다. 1.5 자주 쓰는 스티커 API와 함께 사용하면 더욱 좋습니다.
-
URL
/v0.1/store/package/send/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "stickerList": [ { "stickerId": 3684, //스티커 아이디 "packageId": 347, //패키지 아이디 "stickerImg": "https://img.....l_08.png" //스티커 이미지 주소 }, { "stickerId": 3683, "packageId": 347, "stickerImg": "https://img...._07.png" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/package/send/9937" \ --header "apikey:xxxxxxxxx"
유저가 자주 쓰는 스티커 15개 입니다. 1.4 최근 사용한 스티커 API와 함께 사용하면 더욱 좋습니다. 이 API 또한 유저가 스티커를 전송하는 환경 (주로 키보드 섹션)에 도입하면 됩니다.
-
URL
/v0.1/store/package/frequently/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "stickerList": [ { "stickerId": 3684, //스티커 아이디 "packageId": 347, //패키지 아이디 "stickerImg": "https://img.....l_08.png", //스티커 이미지 주소 "sendCnt": 3 //전송횟수 }, { "stickerId": 3683, "packageId": 347, "stickerImg": "https://img...._07.png", "sendCnt": 1 } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/package/frequently/9937" \ --header "apikey:xxxxxxxxx"
사용자들은 스티커 스토어 API에서 제공되는 스티커를 구매해 사용 할 수 있습니다. 스티커 구매는 접속중인 서비스에서 인앱 결제 혹은 서비스의 내부 코인 시스템을 통해 구매가 이뤄집니다. 구매 완료된 스티커는 해당 API를 통해 다운로드 할 수 있으며 이때 가격 정보가 스티팝에 제공됩니다. 스티팝과 수익 분배는 월 기준으로 익월에 진행되며 이는 스티팝 대시보드 (준비중)에서 자동으로 진행됩니다.
-
URL
/v0.1/store/download/:packageId
-
Method:
POST -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
packageId=[int]패키지 아이디 값 -
Request Query Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값price=[string]각 해당 서비스의 가격정보 전달Not Required:
country=[string]국가별 다운로드 집계를 위한 2자리 국가코드 ex) kr, us, es -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Warning Response:
- Code: 200
Content:{ "header": { "code": "0000", "status": "warning", "message": "중복 구매" }, "body": [] }
- Code: 200
-
Sample Call:
curl --location --request POST "https://bapi.stipop.io/store/v0.1/download/118?userId=9937" \ --header "apikey:xxxxxxxxx"
사용자의 스티커 구매 내역 조회를 통해 사용자의 device 변경 등의 상황에도 리스트를 기록해 보여줄 수 있습니다. 5번 My Sticker 섹션에 있는 '내 스티커 팩 목록 조회', '내 스티커 숨김 및 해제' API 와 함께 사용 할 수 있습니다.
-
URL
/v0.1/store/download/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "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", } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/download/9937" \ --header "apikey:xxxxxxxxx"
앱 내에서 사용자가 사용하는 스티커를 데이터화 하는 것은 매우 중요합니다. 앞으로 사용자에게 보다 개인화된 콘텐츠를 제안하고 스토어 성능을 높일 수 있기 때문입니다. 스티팝은 사용자가 전송한 데이터를 통해 이 기능들을 대시보드에 제공합니다.
-
URL
/v0.1/store/analytics/send/:stickerId
-
Method:
POST -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
stickerId=[int]스티커 아이디 값 -
Request Query Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request POST "https://bapi.stipop.io/store/v0.1/analytics/send/790?userId=9937" \ --header "apikey:xxxxxxxxx"
모든 스티커는 카테고리에 정리되어 있습니다. 카테고리별로 스티커를 리스트하여 사용자에게 보여주면 스토어의 성능이 높아질 수 있습니다. 카테고리 API를 통해 보다 다양하고 효과적인 스토어를 만들어보세요.
-
URL
/v0.1/store/category
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "categoryList": [ { "category": "Animation/Cartoon" }, { "category": "Animals" } ...... ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/category" \ --header "apikey:xxxxxxxxx"
스티커 팩 위시리스트에 추가, 삭제 API 입니다. 좋아요, 나중에 보기 등의 기능으로도 사용 될 수 있습니다.
-
URL
/v0.1/store/wish/:packageId
-
Method:
PUT -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
packageId=[int]패키지 아이디 값 -
Request Query Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request PUT "https://bapi.stipop.io/store/v0.1/wish/118?userId=9937" \ --header "apikey:xxxxxxxxx"
유저가 위시리스트에 담은 스티커를 조회하는 API 입니다.
-
URL
/v0.1/store/wish/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "packageList": [ { "packageId": 118, "artistName": "MightyCat", "packageName": "Stuart", "packageImg": "https://img....7.png", "packageAnimated": "N", "packageCategory": "Animation/Cartoon", "packageKeywords": "Stuart,Sticker", "isNew": "N", "language": "English", "isDownload": "Y" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/wish/9937" \ --header "apikey:xxxxxxxxx"
유저가 다운로드 한 스티커 팩을 조회할 수 있는 API 입니다.
-
URL
/v0.1/store/mysticker/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "packageList":"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" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/mysticker/9937" \ --header "apikey:xxxxxxxxx"
유저가 내 스티커 리스트에서 숨긴 스티커팩을 조회할 수 있는 API 입니다. 구매한 스티커를 삭제할 수 없기 때문에 'Hide/Recover' 기능으로 대신 할 수 있습니다. 5.5 숨김 및 해제 API를 통해 유저가 Hide 하거나 Recover 할 수 있습니다.
-
URL
/v0.1/store/mysticker/hide/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "packageList":"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" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/mysticker/hide/9937" \ --header "apikey:xxxxxxxxx"
유저가 내 스티커 팩 리스트에서 사용하지 않는 스티커를 '숨김' 하거나 '숨김 해제' 할 수 있습니다. 보유한 스티커 팩이 10개가 넘어가면 사용이 불편하기 때문에 꼭 필요한 기능 중 하나입니다.
-
URL
/v0.1/store/mysticker/hide/:userId/:packageId
-
Method:
PUT -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값packageId=[int]패키지 아이디 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request PUT "https://bapi.stipop.io/store/v0.1/mysticker/hide/9937/118" \ --header "apikey:xxxxxxxxx"
유저간 유료 스티커 팩을 선물 할 수 있는 API 입니다. 6.2 받은 선물 확인 API와 함께 사용 될 수 있습니다.
-
URL
/v0.1/store/gift/:packageId/:sendUserId/:receiveUserId
-
Method:
POST -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
packageId=[int]패키지 아이디 값sendUserId=[string]선물을 보내는 유저 고유값receiveUserId=[string]선물을 받는 유저 고유값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request POST "https://bapi.stipop.io/store/v0.1/gift/118/9937/8805" \ --header "apikey:xxxxxxxxx"
유저 A가 유저 B에게 선물 보낸 스티커를 유저 B가 받았는지 유저 A가 확인할 수 있는 API 입니다. 6.1 선물 보내기 API와 함께 사용 될 수 있습니다.
-
URL
/v0.1/store/gift/:packageId/:sendUserId/:receiveUserId
-
Method:
PUT -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
packageId=[int]패키지 아이디 값sendUserId=[string]선물을 보내는 유저 고유값receiveUserId=[string]선물을 받는 유저 고유값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": [] }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request PUT "https://bapi.stipop.io/store/v0.1/gift/118/9937/8805" \ --header "apikey:xxxxxxxxx"
유저가 다른 유저에게 선물 보낸 스티커 팩 목록을 불러오는 API 입니다.
-
URL
/v0.1/store/gift/send/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "packageList": [ { "packageId": 118, "packageName": "Stuart", "packageImg": "https://img..7.png", "packageCategory": "Animation/Cartoon", "packageKeywords": "Stuart,Sticker", "sendUserId": "9937", //보낸 사람 아이디 "receiveUserId": "8805", //받는 사람 아이디 "isReceive": "Y", "sendDate": "2020-07-07T03:09:41.000Z", //보낸 날짜 "receiveDate": "2020-07-07T03:11:38.000Z", //받은 날짜 "packageAnimated": "N", "isNew": "N", "artistName": "MightyCat", "language": "English", "isDownload": "Y", "isWish": "Y" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/gift/send/9937 \ --header "apikey:xxxxxxxxx"
유저가 다른 유저에게서 선물 받은 스티커 팩 목록을 불러오는 API 입니다.
-
URL
/v0.1/store/gift/receive/:userId
-
Method:
GET -
Request Headers
Required:
apikey=[string]Issued apikey value -
Request Path Parameters
Required:
userId=[string]각 개별 사용자를 구분 할 수 있는 고유 값 -
Success Response:
- Code: 200
Content:
{ "header": { "code": "0000", "status": "success", "message": "요청 성공" }, "body": { "packageList": [ { "packageId": 118, "packageName": "Stuart", "packageImg": "https://img..7.png", "packageCategory": "Animation/Cartoon", "packageKeywords": "Stuart,Sticker", "sendUserId": "9937", //보낸 사람 아이디 "receiveUserId": "8805", //받는 사람 아이디 "isReceive": "Y", "sendDate": "2020-07-07T03:09:41.000Z", //보낸 날짜 "receiveDate": "2020-07-07T03:11:38.000Z", //받은 날짜 "packageAnimated": "N", "isNew": "N", "artistName": "MightyCat", "language": "English", "isDownload": "Y", "isWish": "Y" } ] } }
- Code: 200
-
Error Response:
-
Code: 401 UNAUTHORIZED
Content:{ "status": "fail", "message": "non exist apikey", "code": "9000" }OR
-
Code: 500 Internal Server error
Content:{ "status" : "fail", "message": "server error", "code":"1000" }
-
-
Sample Call:
curl --location --request GET "https://bapi.stipop.io/store/v0.1/gift/receive/9937 \ --header "apikey:xxxxxxxxx"
Annoucements를 통해 최신 업데이트 내용을 확인할 수 있습니다.
Stipop Sticker Store API is MIT licensed, as found in the LICENSE file.