skp-coupon v1.2.0

skp-coupon

skp-coupon 패키지는 SK Planet의 시럽월렛(핀크럭스) 제품에서 도움을 받아 맛있는 간식 쿠폰을 단 몇 초만에 생성하고, 이를 전국 각지의 음식 매장으로 배포하는 기능을 가진 패키지 입니다. 평균적으로 쿠폰을 생성하는 데 걸리는 시간은 약 700ms 입니다. 쿠폰은 생성 시 바로 매장에서 바코드를 보여줌으로써 사용이 가능합니다.

v1.2.0 업데이트 : description 추가 & 파트너 변경

시작하기

아래의 예시 코드를 참고하며 skp-coupon의 사용법을 알아보세요.

const coupon = require('skp-coupon')
const user = new coupon.user('user id')
coupon.new(user, 'brand').then((data) => {
    console.log(data)
}).catch(error => {
    console.log('쿠폰을 생성하는 도중 오류가 발생했습니다.')
    console.log(error)
})

혹은 Async/await을 통하여 사용할 수도 있습니다.

const coupon = require('skp-coupon')
const user = new coupon.user('user id')
const cp = await coupon.new(user, 'brand') // (Optional)원하는 브랜드 설정
console.log(cp)

이해하기

모든 쿠폰은 특정한 사용자 이름에 기반하여 생성됩니다. 따라서 2번째 줄에서 특정한 사용자 아이디를 가진 새 사용자를 생성합니다.이는 SK Planet에서 기본적으로 제공되는 기능이며, 비밀번호를 통한 인증은 제공되지 않습니다. 만약 입력된 사용자 이름이 없을 경우 랜덤한 사용자 이름을 생성합니다. 또한, 사용자 이름을 잊어버릴 경우 이미 생성한 쿠폰을 사용할 수 없습니다. 그 후, 3번째 줄에서 coupon.new 메소드를 호출합니다. 이 메소드는 Promise 이므로 .then 및 .catch 메소드를 사용하여 쿠폰을 생성하는 작업을 처리할 수 있습니다. coupon.new 메소드는 2가지 파라미터를 가집니다. 첫번째 파라미터는 coupon.new 메소드로 생성한 사용자 혹은 String 으로 이루어진 사용자 이름이고, 두번째 파라미터는 원하는 브랜드의 이름입니다. 브랜드 이름과 고유 식별자의 대응 관계는 아래에 표로 정리해 두었습니다. 쿠폰 생성에 성공한 경우, .then을 통하여 생성된 쿠폰의 정보를 반환합니다. 아래는 예시로 생성된 쿠폰입니다.

{
  name: '스프링가든 더즌 16%할인(18,800→15,800)',
  link: 'https://freecp.pincrux.com/zeus_culture/coupon_detail.html?ord_no=1561097529&partner_id=culture&member_id=sample&cate=all',
  description: '[ 상품 설명 ]',
  shortenLink: [Function: shortenLink],
  originalPrice: 18800,
  newPrice: 15800,
  coupon: {
    number: 442310797784985340,
    image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIYAAAAeAQMAAADTgvT8AAAABlBMVEX///8AAABVwtN+AAAAAXRSTlMAQObYZgAAAAlwSFlzAAAOxAAADsQBlSsOGwAAACJJREFUKJFjuDxx9/YUj6/vli9fdPfuZOPkNQyjIqMiYBEAGhNGyBSYgmMAAAAASUVORK5CYII=',
    brand: '크리스피크림',
    expiry: '2022-04-30 까지',
    productImage: 'https://seimg.pincrux.com/freecp/10000251355_20220401060105.jpg'
  },
  message: '쿠폰이 발급되었습니다.'
}

쿠폰 보러가기

만약 오류가 발생한 경우 아래와 같은 응답을 .catch로 반환합니다.

{ error: 'E003', message: '이미 발급이나 사용 이력이 있는 쿠폰입니다.' }

URL 단축하기

쿠폰의 shortenLink를 호출함으로써 쿠폰의 URL을 단축할 수 있습니다. 이 메소드 또한 Promise이며, 쿠폰의 URL을 반환합니다. 오류가 발생한 경우 .catch로 오류 정보를 반환합니다.

특정한 브랜드의 쿠폰

브랜드 식별자는 대소문자를 구분하지 않습니다. 위 표는 2022년 4월 기준이며, 브랜드의 추가 및 삭제가 있을 수 있으므로 사전 확인 후 사용하시기 바랍니다.

마치며

이 패키지를 통하여 디스코드 봇 등을 통하여 더 넓은 사용자에게 혜택을 제공할 수 있기를 바랍니다. 이 패키지를 사용함으로써 발생하는 모든 법적 책임은 이를 사용하는 사용자에게 귀속되며, 이 패키지의 제작자는 아무런 법적 책임을 지거나 보증하지 않습니다.