API Reference 홈택스수집 Node.js 회원 관리
5.1. CheckIsMember - 연동회원 가입여부 확인
- 사업자번호를 조회하여 연동회원 가입여부를 확인합니다.
htCasbillService.checkIsMember(CorpNum, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
Response
Throws
PopbillException
5.2. CheckID - 아이디 중복 확인
- 사용하고자 하는 아이디의 중복여부를 확인합니다.
htCasbillService.checkID(ID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
ID |
string |
50 |
Y |
중복여부를 확인할 아이디 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
Response
Throws
PopbillException
사전협의
5.3. JoinMember - 연동회원 신규가입
- 프로그램 공급사의 고객사를 팝빌 연동회원으로 가입하는 API 입니다.
htCasbillService.joinMember(JoinForm, success, error)
- 연동회원 신규가입 API의 과도한 사용을 예방하기 위하여 팝빌과 사전협의 후 지원하고 있습니다.
- 사전협의가 필요한 프로그램 공급사는 팝빌 파트너센터(1600-8536)로 연락주시기 바랍니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
JoinForm |
JoinForm |
- |
Y |
연동회원 객체정보 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
Response
Throws
PopbillException
5.4. GetCorpInfo - 회사정보 확인
htCasbillService.getCorpInfo(CorpNum, UserID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
CorpInfo
Throws
PopbillException
5.5. UpdateCorpInfo - 회사정보 수정
htCasbillService.updateCorpInfo(CorpNum, UserID, CorpInfo, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
CorpInfo |
CorpInfo |
- |
Y |
회사 객체정보 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
Response
Throws
PopbillException
5.10. GetAccessURL - 팝빌 로그인 팝업 URL
- 팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
htCasbillService.getAccessURL(CorpNum, UserID, success, error)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
string - 요청에 대한 응답 URL
Throws
PopbillException
5.11. QuitMember - 팝빌 회원탈퇴
- 팝빌 연동회원을 탈퇴 처리합니다.
- 관리자 계정만 회원탈퇴 가능하며, 관리자를 포함 모든 담당자 계정도 일괄탈퇴 처리됩니다.
htCasbillService.quitMember(CorpNum, QuitReason, UserID, success, error)
잔여포인트가 존재하는 경우, [환불신청 → 회원탈퇴] 프로세스로 구현하시기를 권장합니다.
회원탈퇴 직후 동일 사업자번호 및 아이디로 재가입이 가능합니다.
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
string |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
QuitReason |
string |
200 |
Y |
회원 탈퇴 사유 |
|
UserID |
string |
50 |
N |
팝빌회원 아이디 |
|
success |
function |
- |
Y |
성공에 대한 콜백 함수 |
|
error |
function |
- |
Y |
실패에 대한 콜백 함수 |
Return
Response
Throws
PopbillException
