Stipop Docs | Documentation for SDK and API

Download/Purchase Sticker

사용자는 스티커 팩을 다운로드하여 제공하는 메신저 인터페이스에서 스티커를 보낼 수 있게됩니다. Download/Purchase Sticker API를 사용하여 스티커 다운로드 및 구매를 활성화하세요. 대시보드에서는 무료 스티커 다운로드가 기본으로 설정되어 있습니다. 다음 단계를 통해 스티커를 유료로 판매해 새로운 수익을 창출 할 수도 있습니다. 많은 서비스들에서는 유료 스티커 스토어를 적용하고 있고 스티팝에서 제공되는 최적화된 스티커 스토어 UI Kit를 사용하고 있습니다.

스티커 팩의 각 스티커는 파일 크기가 500KB 미만이며 가장 월활한 사용자 경험을 제공하도록 최적화되어 있습니다. 스티커의 기본 파일 포맷은 안움직이는 스티커의 경우 PNG 이며 움직이는 스티커의 경우 GIF 입니다. 스티커 파일 포맷 및 어떤 방식으로 스티커가 확보되는지에 대해서는 Sticker Guide를 통해 더 상세하게 확일할 수 있습니다.

사용자가 앱에서 '다운로드' 혹은 ‘구매’ 버튼을 클릭할 때 해당 API를 적용해보세요.

Request URL

POST
https://messenger.stipop.io/v1/download/:packageId

Best Practices

  1. 사용자에게 스티커를 무료로 제공할지 혹은 유료로 제공할지 선택하세요. 선택이 어려우시면 무료 스티커로 시작한 뒤 언제나 대시보드에서 유료 스티커로 업데이트 할 수 있습니다.
  2. 다운로드/구매 버튼을 개발할 때 ‘price’ 매개 변수를 미리 적용하면 추후에 무료 스티커에서 유료 스티커로 전환할 때 추가적인 개발을 하지 않아도 괜찮습니다.
  3. 대시보드 Overview에서 스티커 다운로드/구매 횟수를 모니터링 할 수 있습니다. 성능을 극대화 할 수 있도록 가격 모델을 더욱 최적화하도록 도움드리고 있습니다.

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를 사용하면 안됩니다.
isPurchasestring무료 스티커: isPurchaseN으로 설정하세요.
프리미엄(유료) 스티커: isPurchaseY로 설정하세요.
스티커 구독: isPurchaseS로 설정하세요.

중요: You must use the correct value depending on the sticker pricing model you apply on your app and service. If you set the value as Y or S, according revenue share will be made through your billing account on Dashboard. See tutorial for paid sticker store and subscription for more detail.

Warning: If isPurchase is found to be using the wrong value, your API call can be blocked from usage.
OptionalTypeDescription
langstring언어 최적화를 위해 언어 정보를 입력해주세요.
ISO 639-1의 2-letter 언어 코드를 사용하세요.
기본 값: en
countryCodestring국가 최적화를 위해 국가 정보를 입력해주세요.
ISO 3166-1의 2-letter 국가 코드를 사용하세요.
기본 값: US
pricestringisPurchaseY일 경우 기본 가격이 설정됩니다.
기본 가격: 안움직이는 스티커 팩 [$0.99], 움직이는 스티커 팩 [$1.99]
혹은 직접 price 정보를 입력할 수 있습니다.

Example Request

샘플 요청: 스티커 팩 다운로드/구매
1
curl --location --request POST "https://messenger.stipop.io/v1/download/118?userId=9937"  --header "apikey:xxxxxxxxx"

Success Response

성공 응답: 200
1
2
3
4
5
6
7
8
{
  header: {
    code: '0000',
    status: 'success',
    message: 'success',
  },
  body: [],
}

Warning Response:

ErrorCodeDescription
Duplicate download0000사용자가 스티커 팩을 이미 다운로드 했습니다.

Error Response

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