2.1. 회원관리
하이픈에 회원 등록 및 관리하는 API입니다.
가입/수정/탈퇴는 요청구분코드(rqsDscd)로 구분되며 개인정보부분은 제공드린 암호화키로 AES 암호화하여 전송이 필요합니다.
•
HTTP header information
URL | 요청 도메인 + /member/notify |
Method | POST |
Content-Type | Application/json; charset=UTF-8 |
Authorization | Bearer + 스페이스 1byte + 이용사토큰 |
•
전제조건
◦
회원에게 약관을 실시간 동의 받는 경우 : #1번(약관동의)가 실시간으로 일어남
◦
회원에게 약관 사전 동의 받은 경우: 회원이 약관 동의한 시점 ≠ 약관동의 APi 호출시점
sequenceDiagram autonumber 회원->> 이용사플랫폼(app/web) : 약관 동의 note right of 회원 : 실시간 동의 or 사전동의에 따라 시점 차이 발생 이용사플랫폼(app/web) ->> Server(이용사) : 회원 약관동의 정보 Server(이용사) ->> 하이픈 : API호출 하이픈 -->> Server(이용사) : 정상 Server(이용사) -->> 이용사플랫폼(app/web): 정상 이용사플랫폼(app/web) -->> 회원 : 정상
Mermaid
복사
회원관리 비정상 case
•
Request
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | rqsDscd | 요청구분코드 | Y | string | C : 등록(가입), U : 수정, D : 삭제(탈퇴) |
2 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 |
3 | mbrID | 회원ID | Y | string | 이용사의 회원 ID |
4 | mbrNm | 회원명 | Y | string | AES암호화 |
5 | mbtlNo | 휴대전화번호 | Y | string | AES암호화 |
6 | stcd | 상태코드 | Y | string | 00:정상, 10:중지, 20:휴면, 22:블랙, 99:해지 |
7 | monyAmt | 머니금액 | Y | bigint | 회원이 보유하고 있는 모든 머니 금액 |
8 | pntAmt | 유상 포인트금액 | Y | bigint | 회원이 보유하고 있는 유상 포인트 금액 |
9 | fpntAmt | 무상 포인트금액 | Y | bigint | 회원이 보유하고 있는 무상 포인트 금액 |
10 | bdt | 생년월일 | N | String | YYYYMMDD |
11 | sxDscd | 성별구분코드 | N | String | 0:남자, 1:여자, 9:알수없음 |
12 | ntfrDscd | 내외국인구분코드 | N | String | 0:내국인, 1:외국인, 9:알수없음 |
13 | eml | 이메일 | N | String | AES암호화 |
14 | tpcd | 유형코드 | N | String | 0:일반, 1:개인사업자, 2:법인사업자 |
15 | tpVl | 유형값 | N | String | 유형코드가 0(일반)-CI, 1,2(사업자)-사업자번호 |
16 | mmo | 메모 | N | String | 메모 |
17 | mbtcDscd | 통신사구분코드 | N | String | SKT : 1 / KT : 2 / LG : 3 / SKT알뜰폰 : 5 / KT알뜰폰 : 6 / LGU+알뜰폰 : 7 |
18 | dnxSmopYn | 소득공제동의여부 | N | string |
{
"rqsDscd": "요청구분코드",
"uscoSno": "이용사일련번호",
"mbrID": "회원일련번호",
"mbtlNo": "휴대전화번호",
"mbrNm": "회원명",
"monyAmt":"머니금액 - 회원이 보유하고 있는 모든 머니 금액",
"pntAmt":"포인트금액 - 회원이 보유하고 있는 유상 포인트 금액",
"fpntAmt":"포인트금액 - 회원이 보유하고 있는 무상 포인트 금액",
"stcd":"상태코드 00:정상, 10:중지, 20:휴면, 22:블랙, 99:해지",
"bdt": "YYYYMMDD",
"sxDscd": "0:남자, 1:여자, 9:알수없음",
"ntfrDscd": "0:내국인, 1:외국인, 9:알수없음",
"eml": "이메일",
"tpcd": "0:일반, 1:개인사업자, 2:법인사업자",
"tpVl": "유형코드가 0(일반)-CI, 1,2(사업자)-사업자번호",
"mmp" : "메모",
"mbtcDscd": "통신사구분코드 SKT : 1 / KT : 2 / LG : 3 / SKT알뜰폰 : 5 / KT알뜰폰 : 6 / LGU+알뜰폰 : 7"
"dnxSmopYn":"소득공제동의여부"
}
JSON
복사
•
Response
No | 항목 | 항목명 | 필수 | TYPE | 설명 |
1 | sucsFalr | Y | String | 성공 실패 여부 | |
2 | rsltCd | Y | String | 응답 코드
‘HCO000’이 아닌 경우는 모두 오류입니다. | |
3 | rsltMesg | Y | String | 응답 메시지 | |
4 | rsltObj | N | JSON | API별 응답 데이터 | |
4-1 | rqsDscd | 요청구분코드 | Y | string | C : 등록, U : 수정, D : 삭제 |
4-2 | uscoSno | 이용사일련번호 | Y | bigint | 별도 안내 |
4-3 | mbrID | 회원ID | Y | string | 이용사의 회원 ID |
4-4 | mbrNm | 회원명 | Y | string | |
4-5 | mbtlNo | 휴대전화번호 | Y | string | |
4-6 | monyAmt | 머니금액 | Y | bigint | 회원이 보유하고 있는 모든 머니 금액 |
4-7 | pntAmt | 유상포인트 | Y | bigint | 회원이 보유하고 있는 유상 포인트 금액 |
4-8 | fpntAmt | 무상포인트 | Y | bigint | 회원이 보유하고 있는 무상 포인트 금액 |
4-9 | stcd | 상태코드 | Y | string | 00:정상, 10:중지, 20:휴면, 22:블랙, 99:해지 |
4-10 | bdt | 생년월일 | N | String | YYYYMMDD |
4-11 | sxDscd | 성별구분코드 | Y | String | 0:남자, 1:여자, 9:알수없음 |
4-12 | ntfrDscd | 내외국인구분코드 | Y | String | 0:내국인, 1:외국인, 9:알수없음 |
4-13 | eml | 이메일 | N | String | |
4-14 | tpcd | 유형코드 | N | String | 0:일반, 1:개인사업자, 2:법인사업자 |
4-15 | tpVl | 유형값 | N | String | 유형코드가 0(일반)-CI, 1,2(사업자)-사업자번호 |
4-16 | mmo | 메모 | N | String | |
4-17 | mbtcDscd | 통신사구분코드 | N | String | SKT : 1 / KT : 2 / LG : 3 / SKT알뜰폰 : 5 / KT알뜰폰 : 6 / LGU+알뜰폰 : 7 |
4-18 | dnxSmopYn | 소득공제동의여부 | Y | string |
{
"sucsFalr": "성공실패여부(success/fail)",
"rsltCd": "응답코드",
"rsltMesg": "응답메시지",
"rsltObj": {
"rqsDscd": "요청구분코드",
"uscoSno": "이용사일련번호",
"mbrID": "회원일련번호",
"mbtlNo": "휴대전화번호",
"mbrNm": "회원명",
"monyAmt":"머니금액 - 회원이 보유하고 있는 모든 머니 금액",
"pntAmt":"포인트금액 - 회원이 보유하고 있는 유상 포인트 금액",
"fpntAmt":"포인트금액 - 회원이 보유하고 있는 무상 포인트 금액",
"stcd":"상태코드 00:정상, 10:중지, 20:휴면, 22:블랙, 99:해지",
"bdt": "YYYYMMDD",
"sxDscd": "0:남자, 1:여자, 9:알수없음",
"ntfrDscd": "0:내국인, 1:외국인, 9:알수없음",
"eml": "이메일",
"tpcd": "0:일반, 1:개인사업자, 2:법인사업자",
"tpVl": "유형코드가 0(일반)-CI, 1,2(사업자)-사업자번호",
"mbtcDscd": "통신사구분코드 SKT : 1 / KT : 2 / LG : 3 / SKT알뜰폰 : 5 / KT알뜰폰 : 6 / LGU+알뜰폰 : 7"
"dnxSmopYn":"소득공제동의여부"
}
}
JSON
복사