Main Sticker Banner

Main Sticker Banner API를 통해 사용자들에게 매력적인 스티커 배너를 보여줄 수 있습니다. 스티커 배너는 앱 스토어에서 피쳐링 된 앱 배너 같은 이미지입니다. 메인 배너에 피쳐링 된 스티커는 스티팝 콘텐츠 팀이 직접 큐레이션하고 있습니다. 메인 배너를 추가하는 것 만으로 스티커 다운로드 비율을 높일 수 있습니다.

Request URL

GET

https://messenger.stipop.io/v1/curation/type/:type

Best Practices

권장: 최적의 서비스를 위해 언어(lang)와 국가(countryCode) 파라미터를 사용해 사용자 위치 정보를 제공하세요. 스티팝은 사용자의 선호 언어, 문화, 그리고 로컬 트렌드를 적용해 자동으로 최적화된 스티커를 제공합니다. 언어와 국가의 기본값은 각각 en과 US 입니다.
userId 파라미터에 다양한 사용자에 대해 같은 userId 값을 사용하지마세요. 해당 값은 지속적으로 모니터링이 되며 중복값이 사용 될 경우 API key가 비활성화 될 수 있습니다. userId 값은 아무 string 형태의 값이면 됩니다.
limit 파라미터를 사용해 스티커 배너 로딩 속도를 최적화하세요. 예를 들어 limit을 '10'으로 두어 10개의 스티커 배너를 불러오세요.
권장: 사용자가 메신저 인터페이스에서 스티커를 사용 할 때 Register Sticker Send API를 사용해 스티커 전송 기록을 저장하세요.저장된 전송 데이터를 통해 향후 사용자들에게 제공되는 스티커가 보다 최적화 될 수 있으며 사용 데이터를 직접 확인 할 수도 있습니다.
사용자가 스티커 팩을 다운로드 할 시 다음 Download/Purchase Sticker API를 꼭 사용해 다운로드 기록을 남겨주세요. 사용자 스티커 다운로드 정보는 My Sticker Packs, Download/Purchase History 그리고 Recently Viewed Packs 기능을 사용할 때 필수적으로 필요합니다.

Parameters

Request Headers
Required	Type	Description
apikey	string	발급받은 API 키 값: 스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.

Request Path Parameters
Required	Type	Description
type	string	A 타입은 작은 배너 B 타입은 큰 배너 예시: A, B

Request Query Parameters
Required	Type	Description
userId	string	앱 사용자에게 부여되는 고유 값. userId는 아무 string 값이면 됩니다. 중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
lang	string	언어 최적화를 위해 언어 정보를 입력해주세요. ISO 639-1의 2-letter 언어 코드를 사용하세요. 예시: en
countryCode	string	국가 최적화를 위해 국가 정보를 입력해주세요. ISO 3166-1의 2-letter 국가 코드를 사용하세요. 예시: US
Optional	Type	Description
limit	int	The maximum number of main banners. Default Value: 5 (max: 10)

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/curation/type/A?userId=xxx" --header "apikey:xxxxxxxxx"

Success Response

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

{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
      "card": {
          "cardId": 17,
          "title": "Stipop picks",
          "type": "B",
          "imgUrl": null,
          "language": "en",
          "country": "us",
          "packageList": [
              {
                  "packageId": 3651,
                  "packageName": "Tod & Sal",
                  "artistName": "Bare Tree Media",
                  "packageImg": "https://img...LKCyP.gif",
                  "stickerImg": null,
                  "cardImgUrl": "https://img...u6q8C.png",
                  "lightBackgroundCode": "#ffd860",
                  "darkBackgroundCode": "#ffd860",
                  "isDownload": "N",
                  "stickers": null
              }, 
              ........
          ]
      },
      "pageMap": null
  }
}

Response Format

Attributes
Name	Type	Description
cardId	int	Banner card ID
title	string	Banner section title
type	string	Banner type
packageId	int	Sticker package ID
packageName	string	Sticker package name
artistName	string	Name of the artist
packageImg	string	Sticker package image
cardImgUrl	string	URL of banner card image
lightBackgroundCode	string	Light theme background code (customizable)
darkBackgroundCode	string	Dark theme background code (customizable)
isDownload	string	Is sticker downloaded by the user (Y/N)

Error Response

Error	Code	Description
non exist apikey	9000	사용된 API 키가 존재하지 않습니다.
server error	1000	서버에서 정보를 받을 수 없습니다.

이 페이지가 도움이 되셨나요?

도움이 필요하신가요? 문의주세요.

Back

Sticker StoreNEW STICKER PACKAGES

Sticker StoreRECENTLY VIEWED PACKS