원하는 목차 항목을 누르면 해당 내용으로 이동합니다.
2.1. 상점 등록
이 문서는 이용사의 상점을 등록하기 위해 작성되었습니다.
상점의 구조는 현재 아래의 그림과 같이 관리되고 있으며, 프랜차이즈의 경우 대표상점은 프랜차이즈 본사, 하위상점은 직영점이고 일반상점은 가맹점인 개념입니다.
classDiagram 대표상점 <|--하위상점 대표상점 : 상점일련번호 - 1 대표상점 : 상점유형코드 - 10 대표상점 : 대표상점일련번호 - ' ' class 하위상점{ 상점일련번호 - 2 상점유형코드 - 20 대표상점일련번호 - 1 } class 일반상점{ 상점일련번호 - 3 상점유형코드 - 30 대표상점일련번호 - ' ' }
Mermaid
복사
•
HTTP Header Information
URL | 요청 도메인 + /merchantstore/regist |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | uscoSno | 이용사일련번호 | Y | bigint | |
2 | mrstNm | 상점명 | Y | String | |
3 | mrstTpcd | 상점유형코드 | Y | String | 10:대표상점, 20:하위상점,
30:일반상점 |
4 | rpstMrstSno | 대표상점일련번호 | Y | String | mrstTpcd가‘20’인 경우 필수
mrstTpcd가 ‘10’,’30’인 경우 공란 |
5 | bzprNo | 사업자번호 | Y | String | |
6 | rpsrNm | 대표자명 | Y | String | |
7 | rpstTlno | 대표전화번호 | Y | String | |
8 | rpsrEml | 대표이메일 | Y | String | |
9 | rpsrMbtlNo | 대표휴대전화번호 | Y | String | |
10 | zip | 우편번호 | Y | String | |
11 | adr | 주소 | Y | String | |
12 | dtlAdr | 상세주소 | Y | String | |
13 | bztpCd | 업종코드 | Y | String | |
14 | bscnNm | 업태명 | Y | String | |
15 | aplStDt | 영업시작일자 | N | String | 미입력시 등록당일 |
16 | aplEndDt | 영업종료일자 | N | String | 미입력시 9999년 12월 31일 |
{
"uscoSno": "이용사일련번호",
"mrstNm": "상점명",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표전화번호",
"rpsrEml": "대표이메일",
"rpsrMbtlNo": "대표휴대전화번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"aplStDt": "영업시작일자",
"aplEndDt": "영업종료일자"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | uscoSno | 이용사일련번호 | Y | bigint | |
4-2 | mrstSno | 상점일련번호 | Y | bigint | |
4-3 | mrstTkn | 상점access토큰 | Y | String | 포인트거래 시 인증값 사용 |
4-4 | mrstPubKey | 상점공개키 | Y | String | 포인트거래 시 정보 암호화에 사용 |
{
"sucsFalr": "성공 실패 여부",
"rsltCd": "응답 코드",
"rsltMesg": "응답 메시지",
"rsltObj": {
"uscoSno": "이용사일련번호",
"mrstSno": "상점일련번호",
"mrstTkn": "상점access토큰",
"mrstPubKey": "상점공개키"
}
}
JSON
복사
2.2. 상점정보수정
상점 정보를 수정할 수 있습니다.
•
HTTP Header Information
URL | 요청 도메인 + /merchantstore/modify |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 or 상점토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | uscoSno | 이용사일련번호 | Y | bigint | |
2 | mrstSno | 상점일련번호 | Y | bigint | |
3 | mrstNm | 상점명 | N | String | |
4 | mrstStcd | 상점상태코드 | N | String | 00:등록, 10:중지, 99:해지 |
5 | mrstTpcd | 상점유형코드 | N | String | 10:대표상점, 20:하위상점, 30:일반상점 |
6 | rpstMrstSno | 대표상점일련번호 | O | String | mrstTpcd가 ‘10’,’30’인 경우 공란, ‘20’인 경우 필수 |
7 | bzprNo | 사업자번호 | N | String | |
8 | rpsrNm | 대표자명 | N | String | |
9 | rpstTlno | 대표전화번호 | N | String | |
10 | rpsrEml | 대표이메일 | N | String | |
11 | rpsrMbtlNo | 대표휴대전화번호 | N | String | |
12 | zip | 우편번호 | N | String | |
13 | adr | 주소 | N | String | |
14 | dtlAdr | 상세주소 | N | String | |
15 | bztpCd | 업종코드 | N | String | |
16 | bscnNm | 업태명 | N | String | |
17 | aplStDt | 영업시작일자 | N | String | 미입력시 등록당일 |
18 | aplEndDt | 영업종료일자 | N | String | 미입력시 9999년 12월 31일 |
{
"uscoSno": "이용사일련번호",
"mrstSno": "상점일련번호",
"mrstNm": "상점명",
"mrstStcd": "상점상태코드",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표전화번호",
"rpsrEml": "대표이메일",
"rpsrMbtlNo": "대표휴대전화번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태",
"aplStDt": "영업시작일자",
"aplEndDt": "영업종료일자"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | uscoSno | 이용사일련번호 | Y | bigint | |
4-2 | mrstNm | 상점명 | N | String | |
4-3 | mrstStcd | 상점상태코드 | N | String | 00:등록, 10:중지, 99:해지 |
4-4 | mrstTpcd | 상점유형코드 | N | String | 10:대표상점, 20:하위상점, 30:일반상점 |
4-5 | rpstMrstSno | 대표상점일련번호 | O | String | mrstTpcd가 ‘10’,’30’인 경우 공란, ‘20’인 경우 필수 |
4-6 | bzprNo | 사업자번호 | N | String | |
4-7 | rpsrNm | 대표자명 | N | String | |
4-8 | rpstTlno | 대표전화번호 | N | String | |
4-9 | rpsrEml | 대표이메일 | N | String | |
4-10 | rpsrMbtlNo | 대표휴대전화번호 | N | String | |
4-11 | zip | 우편번호 | N | String | |
4-12 | adr | 주소 | N | String | |
4-13 | dtlAdr | 상세주소 | N | String | |
4-14 | bztpCd | 업종코드 | N | String | |
4-15 | bscnNm | 업태명 | N | String | |
4-16 | aplStDt | 영업시작일자 | N | String | 미입력시 등록당일 |
4-17 | aplEndDt | 영업종료일자 | N | String | 미입력시 9999년 12월 31일 |
{
"sucsFalr": "성공 실패 여부",
"rsltCd": "응답 코드",
"rsltMesg": "응답 메시지",
"rsltObj": {
"uscoSno": "이용사일련번호",
"mrstNm": "상점명",
"mrstStcd": "상점상태코드",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표전화번호",
"rpsrEml": "대표이메일",
"rpsrMbtlNo": "대표휴대전화번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"aplStDt": "영업시작일자",
"aplEndDt": "영업종료일자"
}
}
JSON
복사
2.3. 상점 목록 조회
상점 목록 조회를 위한 서비스입니다.
•
HTTP header information
URL | 요청 도메인 + /merchantstore/list/inquiry |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | uscoSno | 이용사일련번호 | Y | bigint | |
2 | pagNo | 페이지번호 | Y | int | |
3 | pagSz | 페이지크기 | Y | int |
{
"uscoSno": "이용사일련번호",
"pagNo": "페이지번호",
"pagSz": "페이지크기"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | uscoSno | 이용사일련번호 | Y | bigint | |
4-2 | pagNo | 페이지번호 | Y | int | |
4-3 | pagSz | 페이지크기 | Y | int | |
반복부 - mrstLst | |||||
1) | mrstSno | 상점일련번호 | Y | bigint | |
2) | mrstNm | 상점명 | Y | String | |
3) | mrstStcd | 상점상태코드 | Y | String | 00:등록, 10:중지, 99:해지 |
4) | mrstTpcd | 상점유형코드 | Y | String | 10:대표상점, 20:하위상점, 30:일반상점 |
5) | rpstMrstSno | 대표상점일련번호 | Y | String | mrstTpcd가 ‘20’인 경우 필수mrstTpcd가 ‘10’,’30’인 경우 공란 |
6) | bzprNo | 사업자번호 | Y | String | |
7) | rpsrNm | 대표자명 | Y | String | |
8) |
rpstTlno | 대표전화번호 | Y | String | |
9) | rpsrEml | 대표이메일 | Y | String | |
10) | rpsrMbtlNo | 대표휴대전화번호 | Y | String | |
11) | zip | 우편번호 | Y | String | |
12) | adr | 주소 | Y | String | |
13) | dtlAdr | 상세주소 | Y | String | |
14) | bztpCd | 업종코드 | Y | String | |
15) | bscnNm | 업태명 | Y | String | |
16) | aplStDt | 영업시작일자 | Y | String | |
17) | aplEndDt | 영업종료일자 | Y | String | |
18) | lat | 위도좌표 | Y | double | |
19) | lng | 경도좌표 | Y | double | |
20) | enrDt | 등록일자 | Y | String | |
21) | enrTm | 등록시각 | Y | String | |
22) | enrId | 등록ID | Y | String | |
23) | lastChgDt | 최종변경일자 | Y | String | |
24) | lastChgTm | 최종변경시각 | Y | String | |
25) | lastChgId | 최종변경ID | Y | String |
{
"sucsFalr": "성공 실패 여부",
"rsltCd": "응답 코드",
"rsltMesg": "응답 메시지",
"rsltObj": {
"uscoSno": "이용사일련번호",
"pagNo": "페이지번호",
"pagSz": "페이지크기",
"반복부 - mrstLst": {
"mrstSno": "상점일련번호",
"mrstNm": "상점명",
"mrstStcd": "상점상태코드",
"mrstTpcd": "상점유형코드",
"rpstMrstSno": "대표상점일련번호",
"bzprNo": "사업자번호",
"rpsrNm": "대표자명",
"rpstTlno": "대표전화번호",
"rpsrEml": "대표이메일",
"rpsrMbtlNo": "대표휴대전화번호",
"zip": "우편번호",
"adr": "주소",
"dtlAdr": "상세주소",
"bztpCd": "업종코드",
"bscnNm": "업태명",
"aplStDt": "영업시작일자",
"aplEndDt": "영업종료일자",
"lat": "위도좌표",
"lng": "경도좌표",
"enrDt": "등록일자",
"enrTm": "등록시각",
"enrId": "등록ID",
"lastChgDt": "최종변경일자",
"lastChgTm": "최종변경시각",
"lastChgId": "최종변경ID"
}
}
}
JSON
복사
2.4. 상점토큰발급
상점 등록 시 발급받은 토큰을 유실/탈취 되었을 경우 새로 토큰을 발급합니다.
•
HTTP header information
URL | 요청 도메인 + /merchantstore/create/token |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 |
2 | mrstSno | 상점일련번호 | Y | bigint | |
3 | bzprNo | 사업자번호 | Y | bigint | |
4 | vrfVl | 검증값 | Y | String | 사업자번호 RSA암호화 |
{
"uscoSno": "이용사일련번호",
"mrstSno": "상점일련번호",
"bzprNo": "사업자번호",
"vrfVl": "검증값"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 |
4-2 | mrstSno | 상점일련번호 | Y | bigint | |
4-3 | mrstAcsTkn | 상점access토큰 | Y | String |
{
"sucsFalr": "성공 실패 여부",
"rsltCd": "응답 코드",
"rsltMesg": "응답 메시지",
"rsltObj": {
"uscoSno": "이용사일련번호",
"mrstSno": "상점일련번호",
"mrstAcsTkn": "상점access토큰"
}
}
JSON
복사