회원 관리

1. CheckIsMember - 연동회원 가입여부 확인

사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

def checkIsMember(CorpNum)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `0` 미가입 `1` 가입
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

2. CheckID - 연동회원 아이디 중복 확인

사용하고자 하는 아이디의 중복여부를 확인합니다.

def checkID(checkID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CheckID`	str	50	Y	중복여부를 확인할 아이디

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `0` 미사용 `1` 사용
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

3. JoinMember - 연동회원 신규가입

프로그램 공급사의 고객사를 팝빌 연동회원으로 가입하는 API 입니다.

def joinMember(JoinInfo)

회원의 정보가 현행화 되지 않은 경우 연동회원 신규가입 API 사용이 제한될 수 있으니 유의하시기 바랍니다.

요청

Parameters

순번 변수명 타입 길이 필수 설명

JoinInfo

연동회원 객체정보

JoinForm

순번	변수명	타입	길이	필수	설명
1	`ID`	str	50	Y	아이디 6자 이상 50자 이하
2	`Password`	str	20	Y	비밀번호 8자 이상 20자 이하 영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
3	`LinkID`	str	20	Y	파트너 링크아이디 팝빌에서 발급한 링크아이디
4	`CorpNum`	str	10	Y	사업자번호 ('-' 제외)
5	`CEOName`	str	100	Y	대표자 성명
6	`CorpName`	str	200	Y	회사명
7	`Addr`	str	300	Y	사업장 주소
8	`BizType`	str	100	Y	업태
9	`BizClass`	str	100	Y	종목
10	`ContactName`	str	100	Y	담당자 성명
11	`ContactEmail`	str	100	Y	담당자 메일
12	`ContactTEL`	str	20	Y	담당자 휴대폰

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

4. QuitMember - 연동회원 탈퇴

팝빌 연동회원을 탈퇴 처리합니다.

관리자를 포함한 모든 담당자가 일괄 삭제 처리됩니다.

def QuitMember(CorpNum, QuitReason, UserID=None)

잔여포인트가 존재하는 경우, [환불신청 → 회원탈퇴] 프로세스로 구현하시기를 권장합니다.
회원탈퇴 직후 동일 사업자번호 및 아이디로 재가입이 가능합니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`QuitReason`	str	200	Y	회원 탈퇴 사유
3	`UserID`	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

5. GetCorpInfo - 회사정보 확인

연동회원의 회사정보를 확인합니다.

def getCorpInfo(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`UserID`	str	50	N	팝빌회원 아이디

응답

CorpInfo

순번	변수명	타입	길이	설명
1	`ceoname`	str	100	대표자 성명
2	`corpName`	str	200	회사명
3	`addr`	str	300	주소
4	`bizType`	str	100	업태
5	`bizClass`	str	100	종목

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

6. UpdateCorpInfo - 회사정보 수정

연동회원의 회사정보를 수정합니다.

def updateCorpInfo(CorpNum, CorpInfo, UserID=None)

요청

Parameters

순번 변수명 타입 길이 필수 설명

CorpNum

str

팝빌회원 사업자번호 ('-' 제외)

CorpInfo

회사 객체정보

CorpInfo

순번	변수명	타입	길이	필수	설명
1	`ceoname`	str	100	Y	대표자 성명
2	`corpName`	str	200	Y	회사명
3	`addr`	str	300	Y	주소
4	`bizType`	str	100	Y	업태
5	`bizClass`	str	100	Y	종목

UserID

str

팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

7. RegistContact - 담당자 추가

연동회원에 담당자를 추가합니다.

def registContact(CorpNum, ContactInfo, UserID=None)

요청

Parameters

순번 변수명 타입 길이 필수 설명

CorpNum

str

팝빌회원 사업자번호 ('-' 제외)

ContactInfo

담당자 객체정보

ContactInfo

순번	변수명	타입	길이	필수	설명
1	`id`	str	50	Y	아이디 6자 이상 50자 이하
2	`password`	str	20	조건부	비밀번호 8자 이상 20자 이하 영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함 함수 [RegistContact - 담당자 추가]호출을 위한 필수값
3	`personName`	str	100	Y	담당자 성명
4	`tel`	str	20	Y	담당자 휴대폰
5	`email`	str	100	Y	담당자 메일
6	`searchRole`	int	1	N	권한 `1` 개인권한 `2` 읽기권한 `3` 회사권한 : 기본값

UserID

str

팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

8. GetContactInfo - 담당자 정보 확인

연동회원에 추가된 담당자 정보를 확인합니다.

def getContactInfo(CorpNum, ContactID, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`ContactID`	str	50	Y	담당자 아이디
3	`UserID`	str	50	N	팝빌회원 아이디

응답

ContactInfo

순번	변수명	타입	길이	설명
1	`id`	str	50	아이디
2	`personName`	str	100	담당자 성명
3	`tel`	str	20	담당자 휴대폰
4	`email`	str	100	담당자 메일
5	`regDT`	str	14	등록일시 형식 : yyyyMMddHHmmss
6	`searchRole`	int	1	권한 `1` 개인권한 `2` 읽기권한 `3` 회사권한
7	`mgrYN`	bool	-	역할 `True` 관리자 `False` 담당자 팝빌 사이트 [ 마이페이지 > 회사정보 > 담당자 관리 ] 메뉴에서 수정 가능
8	`state`	int	1	계정상태 `1` 사용중

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

9. ListContact - 담당자 목록 확인

연동회원에 추가된 담당자 목록을 확인합니다.

def listContact(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`UserID`	str	50	N	팝빌회원 아이디

응답

ContactInfo[ ]

순번	변수명	타입	길이	설명
1	`id`	str	50	아이디
2	`personName`	str	100	담당자 성명
3	`tel`	str	20	담당자 휴대폰
4	`email`	str	100	담당자 메일
5	`regDT`	str	14	등록일시 형식 : yyyyMMddHHmmss
6	`searchRole`	int	1	권한 `1` 개인권한 `2` 읽기권한 `3` 회사권한
7	`mgrYN`	bool	-	역할 `True` 관리자 `False` 담당자 팝빌 사이트 [ 마이페이지 > 회사정보 > 담당자 관리 ] 메뉴에서 수정 가능
8	`state`	int	1	계정상태 `1` 사용중

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

10. UpdateContact - 담당자 정보 수정

연동회원에 추가된 담당자 정보를 수정합니다.

def updateContact(CorpNum, ContactInfo, UserID=None)

요청

Parameters

순번 변수명 타입 길이 필수 설명

CorpNum

str

팝빌회원 사업자번호 ('-' 제외)

ContactInfo

담당자 객체정보

ContactInfo

순번	변수명	타입	길이	필수	설명
1	`id`	str	50	Y	아이디 6자 이상 50자 이하
2	`password`	str	20	조건부	비밀번호 8자 이상 20자 이하 영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함 함수 [RegistContact - 담당자 추가]호출을 위한 필수값
3	`personName`	str	100	Y	담당자 성명
4	`tel`	str	20	Y	담당자 휴대폰
5	`email`	str	100	Y	담당자 메일
6	`searchRole`	int	1	N	권한 `1` 개인권한 `2` 읽기권한 `3` 회사권한 : 기본값

UserID

str

팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

11. DeleteContact - 담당자 삭제

연동회원에 추가된 담당자를 삭제합니다.

def deleteContact(CorpNum, ContactID, UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`ContactID`	str	50	Y	삭제할 담당자 아이디 관리자는 삭제 불가
3	`UserID`	str	50	Y	팝빌회원 아이디 관리자만 요청 가능

응답

Response

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지

12. GetAccessURL - 팝빌 로그인 팝업 URL

팝빌 로그인 팝업 URL 미리보기

팝빌 회원 로그인 상태의 팝업 URL을 반환합니다.

권장 사이즈 : width = 1,280px (최소 1,000px) / height = 800px
반환되는 URL은 30초 동안만 사용이 가능합니다.
반환되는 URL은 팝빌회원의 로그인 세션을 포함하고 있으니 사용에 유의하여 주시기 바랍니다.

def getAccessURL(CorpNum, UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	`CorpNum`	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	`UserID`	str	50	N	팝빌회원 아이디

응답

str - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	`code`	int	-	API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드
2	`message`	str	-	API 처리 실패에 대한 오류메시지