👥

2. 회원관리

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
복사

2.2. 회원 일괄 관리 API

하이픈에 회원 일괄 등록 및 관리하는 API입니다. ( 총 3000건 요청가능 )

가입/수정은 요청구분코드(rqsDscd)로 구분되며 개인정보부분은 제공드린 암호화키로 AES 암호화하여 전송이 필요합니다.

•

HTTP header information

URL	요청 도메인 + /member/notify/list
Method	POST
Content-Type	Application/json; charset=UTF-8
Authorization	Bearer + 스페이스 1byte + 이용사토큰

•

Request

No	항목	항목명	필수	TYPE	설명
1	memberList	회원정보 리스트	Y	List[Object]	회원 정보를 담은 리스트 (아래 memberList 내부 항목 참고)
1.1	rqsDscd	요청구분코드	Y	string	요청 유형 (C: 등록, U: 수정)
1.2	uscoSno	이용사일련번호	Y	bigint	이용사 고유 식별번호
1.3	mbrID	회원ID	Y	string	이용사의 회원 ID
1.4	mbrNm	회원명	Y	string	회원 이름 (AES 암호화 필요)
1.5	mbtlNo	휴대전화번호	Y	string	휴대폰 번호 (AES 암호화 필요)
1.6	stcd	상태코드	Y	string	00: 정상, 10: 중지, 20: 휴면, 22: 블랙, 99: 해지
1.7	monyAmt	머니금액	Y	bigint	회원이 보유한 총 머니 금액
1.8	pntAmt	유상포인트금액	Y	bigint	회원이 보유한 유상 포인트 금액
1.9	bdt	생년월일	N	string	회원 생년월일 (YYYYMMDD)
1.1	sxDscd	성별구분코드	N	string	0: 남자, 1: 여자, 9: 알 수 없음
1.11	ntfrDscd	내외국인구분코드	N	string	0: 내국인, 1: 외국인, 9: 알 수 없음
1.12	eml	이메일	N	string	회원 이메일 (AES 암호화 필요)
1.13	tpcd	유형코드	N	string	0: 일반, 1: 개인사업자, 2: 법인사업자
1.14	tpVl	유형값	N	string	유형코드가 0(일반)일 경우 CI, 1, 2(사업자)일 경우 사업자번호
1.15	mbtcDscd	통신사구분코드	N	string	SKT: 1, KT: 2, LG: 3, SKT 알뜰폰: 5, KT 알뜰폰: 6, LGU+ 알뜰폰: 7
1.16	dnxSmopYn	소득공제동의여부	N	string	소득공제 동의 여부 (Y/N)

	{
	    "memberList": [
	        {
				    "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	dateTime	요청일시	Y	string	YYYYMMDDHHmmss

{
    "sucsFalr": "성공실패여부(success/fail)",
    "rsltCd": "응답코드",
    "rsltMesg": "응답메시지",
    "rsltObj": {
		    "dateTime": "요청일시"
		}
}
JSON
복사

2.2.1 회원 일괄 등록 상태 확인 API

하이픈에 회원 일괄 등록 및 관리하는 API입니다. ( 총 3000건 요청가능 )

가입/수정은 요청구분코드(rqsDscd)로 구분되며 개인정보부분은 제공드린 암호화키로 AES 암호화하여 전송이 필요합니다.

•

HTTP header information

URL	요청 도메인 + /member/notify/listChk
Method	POST
Content-Type	Application/json; charset=UTF-8
Authorization	Bearer + 스페이스 1byte + 이용사토큰

•

Request

No	항목	항목명	필수	TYPE	설명
1	dateTime	요청일시	Y	String	회원 일괄 관리 API 응답 필드 “dateTime” 데이터를 기입(

	{
						 "dateTime": "요청일시",
	}
JSON
복사

•

Response 

No	항목	항목명	필수	TYPE	설명
1	sucsFalr		Y	String	성공 실패 여부
2	rsltCd		Y	String	응답 코드‘HCO000’이 아닌 경우는 모두 오류입니다.
3	rsltMesg		Y	String	응답 메시지
4	rsltObj		N	JSON	API별 응답 데이터
4-1	requestCnt	Y	Integer	요청한 총 건수	YYYYMMDDHHmmss
4-2	successCnt	Y	Integer	처리 성공 건수
4-3	failCnt	Y	Integer	처리 실패 건수
4-4	unCheckCnt	Y	Integer	알수 없는 오류 건수
4-5	failData	N	Array	실패한 데이터 목록
4-5-1	mbrId	Y	String	실패한 회원 ID
4-5-2	errMsg	Y	String	실패 상세 메시지

{
    "sucsFalr": "success",
    "rsltCd": "HCO000",
    "rsltMesg": "정상으로 처리되었어요",
    "rsltObj": {
        "requestCnt": 3000,
        "successCnt": 2998,
        "failCnt": 2,
        "unCheckCnt": 0,
        "failData": [
            {
                "mbrId": "1234",
                "errMsg": "이미 가입되셨어요"
            },
            {
                "mbrId": "5678",
							  "errMsg": "이미 가입되셨어요"
            }  
            ]
    }
}
JavaScript
복사