Professional Documents
Culture Documents
기프티쇼비즈 API연동규격서
기프티쇼비즈 API연동규격서
1/31
기프티쇼 비즈 API
연동규격서(V0.0.95)
P. 2/31
문서정보
문서개요
주의사항 (5가지)
기타 문의사항
변경내역
버전 일자 이력사항 작성자
0.0.3
목차
1. 상품 리스트 ........................................................................................................................................................................ 6
2 상품 상세 정보 ................................................................................................................................................................10
3 브랜드 정보 조회 ............................................................................................................................................................14
4 브랜드 상세 정보 ............................................................................................................................................................16
5 쿠폰 상세 정보 ................................................................................................................................................................18
6 쿠폰 취소 ..........................................................................................................................................................................22
7 쿠폰 재전송 ......................................................................................................................................................................23
8 쿠폰발송요청 ....................................................................................................................................................................24
9 현재 비즈머니 잔액 정보 .............................................................................................................................................27
부록 1. 에러 코드 ............................................................................................................................................................. 28
부록 2. 잦은 질문과 답변 ............................................................................................................................................... 31
P. 5/31
연동방식
통신방식
다.
API관련 사항
1. 파라미터 관련 사항
상용승인 완료 되면 자동 발급 됩니다.
2. 암호화 설정
1. 상품 리스트
상품 리스트 API는 상품의 ‘이미지’, ‘이름’, ‘설명’등의 정보를 제공하여, 전체 상품을 확인할 수 있습니다.
또한 카테고리, 브랜드 등의 분류 정보를 제공하여 카테고리, 브랜드별 페이지를 구성할 수 있습니다.
(권장) 호출되는 이미지는 새벽시간대에 배치로 전체 리스트를 저장 하시는 것을 권장 합니다.
(주의) 고객이 페이지를 호출 시에 당사 리스트를 조회 하여 제공하는 경우 속도에 영향이 있습니다.
1.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/goods
상용 https://bizapi.giftishow.com/bizApi/goods
Parameter명 필수여부 요청 형식 타입 설명
1.5 Response
P. 7/31
{
"code": "0000",
" message": null,
"result": {
"listNum": 8,
"goodsList": [
{
"rmIdBuyCntFlagCd": "N",
"discountRate": 6,
"mdCode": "M000100615",
"endDate": "2999-12-30T15:00:00.000+0000",
"affliateId": "ELEVEN",
"discountPrice": 750,
"mmsGoodsImg": "https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811_250.jpg”,
"srchKeyword": "광동)비타500, 비타민, 건강음료, 세븐일레븐",
"limitDay": 30,
"content": "내용”
"goodsImgB": "https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811.jpg",
"goodsTypeNm": "일반상품(물품교환형)",
"exhGenderCd": "WOMAN",
"exhAgeCd": "10",
"validPrdDay": "20190814",
"goodsComName": "세븐일레븐",
"goodsName": "광동)비타500 100ml 병",
"mmsReserveFlag": "Y",
"popular": 1,
"goodsStateCd": "SALE",
"brandCode": "BR00046",
"goodsNo": 21445,
"brandName": "세븐일레븐",
"mmsBarcdCreateYn": "Y",
"salePrice": 800,
"brandIconImg": "https://biz.giftishow.com/Resource/brand/BR_20140528_171011_3.jpg",
"goodsComId": "S000002705",
"rmCntFlag": "N",
"saleDateFlagCd": "PERIOD_SALE",
"contentAddDesc": "",
"goodsCode": "G00000280811",
"goodsTypeDtlNm": "편의점",
"category1Seq": 4,
"goodsImgS": "https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811_250.jpg",
"affiliate": "세븐일레븐/바이더웨이",
"validPrdTypeCd": "01",
"saleDateFlag": "N",
"realPrice": 800,
}
]
}
}
P. 8/31
Response명 타입 길이 설명
goodsNo String 10 상품 번호
2 상품 상세 정보
개별 상품의 정보를 조회 할 수 있습니다.
(권장) 고객이 상품리스트 중 단일 상품에 대해 상세페이지를 안내할 경우 호출하여 고객에게 제공 합니다.
2.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/goods/{goods_code}
상용 https://bizapi.giftishow.com/bizApi/goods/{goods_code}
Parameter명 필수여부 요청 형식 타입 설명
2.5 Response
P. 11/31
{
"code": "0000",
"message": null,
"result": {
"goodsDetail": {
"rmIdBuyCntFlagCd": "N",
"discountRate": 6,
"goldPrice": 750,
"mdCode": "M000100615",
"vipDiscountRate": 9,
"discountPrice": 750,
"mmsGoodsImg":"https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811_250.jpg",
"limitDay": 30,
"content": "해당 쿠폰은 일부 점포에서는 취급하지 않는 상품일 수 있습니다.",
"goodsDescImgWeb" :
"goodsImgB": "https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811.jpg",
"goodsTypeNm": "일반상품(물품교환형)",
"categoryName1": "편의점/마트",
"vipPrice": 730,
"goodsName": "광동)비타500 100ml 병",
"mmsReserveFlag": "Y",
"goodsStateCd": "SALE",
"brandCode": "BR00046",
"goldDiscountRate": 6,
"goodsNo": 21445,
"platinumPrice": 710,
"brandName": "세븐일레븐",
"salePrice": 800,
"brandIconImg": "https://biz.giftishow.com/Resource/brand/BR_20140528_171011_3.jpg",
"rmCntFlag": "N",
"goodsTypeCd": "GNR",
"platinumDiscountRate": 11,
"saleDateFlagCd": "PERIOD_SALE",
"contentAddDesc": "",
"categorySeq1": 4,
"goodsCode": "G00000280811",
"goodsTypeDtlNm": "편의점",
"goodsImgS": "https://biz.giftishow.com/Resource/goods/G00000280811/G00000280811_250.jpg",
"affiliate": "세븐일레븐/바이더웨이",
"saleDateFlag": "N",
"realPrice": 800,
}
}
}
P. 12/31
Response명 타입 길이 설명
goodsNo String 10 상품 번호
3 브랜드 정보 조회
상품의 브랜드를 이미지화 하여 분류 할 수 있도록 기능을 제공 합니다.
3.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/brands
상용 https://bizapi.giftishow.com/bizApi/brands
Parameter명 필수여부 요청 형식 타입 설명
3.5 Response
{
"code": "0000",
"message": null,
"result": {
"listNum": 134,
"brandList": [
{
"brandName": "BHC",
"brandSeq": 612,
"category1Name": "피자/버거/치킨",
"sort": 1,
"content": "",
"brandBannerImg": "https://biz.giftishow.com/Resource/brand/BR_20140807_103157_1.jpg",
"mmsThumImg": "https://biz.giftishow.com/Resource/brand/BR_20140807_103157_4.jpg",
"category2Seq": 0,
"brandIConImg": "https://biz.giftishow.com/Resource/brand/BR_20140807_104934_3.jpg",
"category1Seq": 5,
"brandCode": "BR00109",
"category2Name": "편의점/마트",
}
]
}
}
Response명 타입 길이 설명
sort String 10 정렬
P. 16/31
4 브랜드 상세 정보
단일 브랜드의 정보를 제공 합니다.
4.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/brands/{brand_code}
상용 https://bizapi.giftishow.com/bizApi/brands/{brand_code}
Parameter명 필수여부 요청 형식 타입 설명
4.5 Response
{
"code": "0000",
"message": null,
"result": {
"brandDetail": {
"brandName": "도미노피자",
"brandSeq": 592,
"category1Name": "피자/버거/치킨",
"sort": 4,
"content": "",
"brandBannerImg": "https://biz.giftishow.com/Resource/brand/BR_20140729_173930_1.jpg",
"mmsThumImg": "https://biz.giftishow.com/Resource/brand/20170821_143358479.jpg",
"category2Seq": 0,
"brandIConImg": "https://biz.giftishow.com/Resource/brand/20170821_143401538.jpg",
"category1Seq": 5,
"brandCode": "BR00026",
"category2Name": "편의점/마트"
}
}
}
Response명 타입 길이 설명
sort String 10 정렬
P. 18/31
5 쿠폰 상세 정보
발송에 사용된 TR_ID(고유값)를 활용하여 쿠폰 상세정보를 조회합니다.
5.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/coupons
상용 https://bizapi.giftishow.com/bizApi/coupons
Parameter명 필수여부 요청 형식 타입 설명
5.5 Response
P. 19/31
"code": "0000",
"message": null,
"result": [
{
"couponInfoList": [
{
"goodsCd": "G00000271016",
"pinStatusCd": "07",
"goodsNm": "크라운)마이쮸(딸기)800",
"sellPriceAmt": "800",
"senderTelNo": "15880108",
"cnsmPriceAmt": "800",
"sendRstCd": null,
"pinStatusNm": "구매취소(폐기)",
"mmsBrandThumImg": "20190423_171201873.jpg",
"brandNm": "GS25",
"sendRstMsg": null,
"correcDtm": "20201202",
"recverTelNo": "01068016579",
"validPrdEndDt": "20210101235959",
"sendBasicCd": "2020120200010847976801",
"sendStatusCd": "발송완료"
}
],
"resCode": "0000",
"resMsg": "정상처리"
}
]
}
출력되는 결과의 데이터 포맷은 JSON이며 형식은 아래와 같습니다
Response명 타입 길이 설명
※ 핀상태 코드/이름
핀상태 코드
발행 01
교환(사용완료) 02
반품 03
관리폐기 04
환불 05
재발행 06
구매취소(폐기) 07
기간만료 08
바우처(비활성) 09
잔액환불 10
잔액기간만료 11
P. 21/31
기간만료취소 12
환전 13
환급 14
잔액환급 15
잔액기간만료취소 16
등록 21
등록취소 22
선점 23
임시발급상태 24
P. 22/31
6 쿠폰 취소
오발송 등의 사유로 쿠폰을 취소 해야할 경우 사용 합니다.
(권고) 1개의 쿠폰을 취소하여 응답을 받은 뒤 2번째 쿠폰의 취소요청을 보내주셔야 합니다.
(주의) 응답을 받지 못하여 ‘타임아웃’ 된 경우 재시도 하여 결과값을 받고 저장 합니다.
(주의) 최초에 성공하였으나 응답만을 받지 못해 재시도 결과 ‘이미 취소된 쿠폰’으로 안내 받을 수 있습니다.
(주의) 상거래법 상 구매확정 기간인 7일 이후 구매 취소는 불가 합니다. (*취소 필요 시 1:1 문의 진행)
6.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/cancel
상용 https://bizapi.giftishow.com/bizApi/cancel
Parameter명 필수여부 요청 형식 타입 설명
6.5 Response
{
"code": "0000",
"message": "정상처리 되었습니다."
}
출력되는 결과의 데이터 포맷은 JSON이며 형식은 아래와 같습니다
Response명 타입 길이 설명
7 쿠폰 재전송
MMS를 삭제한 수신 고객의 쿠폰을 재전송 할 수 있습니다.
(주의) 고객의 요청에 따라 사용을 해야 합니다. (*일괄 전송 불가 / 법적인 책임을 물수 있습니다.)
7.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/resend
상용 https://bizapi.giftishow.com/bizApi/resend
Parameter명 필수여부 요청 형식 타입 설명
7.5 Response
{
"code": "0000",
"message": null,
"result": null
}
출력되는 결과의 데이터 포맷은 JSON이며 형식은 아래와 같습니다
Response명 타입 길이 설명
8 쿠폰발송요청
(주의) tr_id는 고유값이어야 합니다.
(필수사항) 자리수: 25자 이하 입니다.
(권고사항) service_20190814_12345678 형식으로 생성 부탁드립니다.
(주의) mms_title 는 10자를 넘으면 안됩니다.
(주의) 응답결과를 받지 못하는 경우(타임아웃 15초), 동일 TR_ID로 ‘쿠폰취소요청’을 보내주셔야 합니다.
사유는 기프티쇼 비즈 플랫폼에서는 발행이 되어 있을 가능성이 높습니다.(*비즈머니 차감)
(주의) 서비스가 보유한 리워드포인트의 교환 시, 리워드포인트의 차감성공 후 발송요청을 보내주셔야 합니다.
(기타) ‘gubun’의 옵션은 3가지 타입의 발송기능을 제공 됩니다.
8.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/send
상용 https://bizapi.giftishow.com/bizApi/send
Parameter명 필수여부 요청 형식 타입 설명
MMS발송 구분자
gubun 필수 파라미터 String - Y: 핀번호수신
- N: MMS
- I: 바코드이미지수신
8.5 Response
MMS (gubun – N)
{
“code”: “0000”,
“message”: null,
“result”: {
“code”: “0000”,
“message”: null,
“result”: {
“orderNo”: “20190716000323”
}
}
}
핀수신 (gubun – Y)
{
“code”: “0000”,
“message”: null,
“result”: {
“code”: “0000”,
“message”: null,
“result”: {
“orderNo”: “20190812000000”,
“pinNo”: “900343630367”
}
}
}
핀수신 (gubun – I)
{
“code”: “0000”,
“message”: null,
“result”: {
“code”: “0000”,
“message”: null,
“result”: {
“orderNo”: “20190812000000”,
“pinNo”: “900343630367”,
"couponImgUrl": "http://t.giftishow.co.kr/mms_90012345678_01.jpg"
}
}
}
P. 26/31
Response명 타입 길이 설명
9 현재 비즈머니 잔액 정보
비즈머니가 잔액이 없을 경우 발송이 되지 않습니다. 서비스의 백오피스에서 조회 할수 있도록 구현 가능합니다. 또한 발송, 취소
등의 거래 정보를 저장할 때 비즈머니 잔액과의 정합성을 비교 할 수 있도록 구현 하시면 됩니다.
9.3 URL
구분 연동 URL
테스트 https://bizapi.giftishow.com/bizApi/bizmoney
상용 https://bizapi.giftishow.com/bizApi/bizmoney
Parameter명 필수여부 요청 형식 타입 설명
9.5 Response
{
“code”: “0000”,
“message”: “"
“balance” : “250000”
}
출력되는 결과의 데이터 포맷은 JSON이며 형식은 아래와 같습니다
Response명 타입 길이 설명
부록 1. 에러 코드
# # http ststus code 와 별개로 아래와 같은 에러코드가 전달 될 수 있습니다.
200 Success 요청 처리 성공
권한 없음
401 Unathorized
(자원에 대한 ACL 에 기인한 권한 없음)
외부 서비스가 현재 멈춘 상태 이거나
503 Service Unavailable
또는 이용할 수 없는 서비스
# COMMON 관련
0000 정상처리
ERR0000 알수 없는 에러 입니다.
ERR0208 상품 주문 관련 오류
ERR0209 상품 주문 메시지 관련 오류
ERR0217 MMS 번호 번호 변경 불가
ERR0214 TR ID 가 없습니다.
ERR0215 TR ID 가 중복되었습니다.
ERR0300 회원정보 조회 실패
ERR0800 비즈포인트 조회 오류
ERR0803 비즈포인트 차감 오류
ERR0804 비즈포인트 적립 오류
ERR0805 쿠폰취소 실패
ERR0808 이미 취소된 쿠폰
ERR0817 수신전화번호 오류
P. 30/31
ERR0999 쿠폰발송오류
PAG0001 페이징 관련 오류
PAG0002 페이징 관련 오류
# 쿠폰 관련
부록 2. 잦은 질문과 답변
(2) 개인정보 처리 위탁을 하는 업무의 내용: 기프티쇼 발송과 고객센터에서의 조회, 재전송
관련 업무 일체
유효기간 종료 후
유효기간 할인
환불/기간연장
B2C 거래 상품별 상이 O X
3. 상품 검색 방법
현재 API 상 카테고리 별 검색은 지원하지 않고 있습니다. 이에 API로 모든 상품을 호출하고,