회원 관리

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

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

def checkIsMember(corpNum, linkID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	linkID	String	-	Y	팝빌에서 발급한 링크아이디

응답

Response

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

예외

PopbillException

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

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

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

def checkID(idValue)

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

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

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

def joinMember(joinInfo)

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

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

4. GetCorpInfo - 회사정보 확인

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

def getCorpInfo(corpNum, userID = "")

요청

Parameters

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

응답

CorpInfo

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

예외

PopbillException

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

5. UpdateCorpInfo - 회사정보 수정

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

def updateCorpInfo(corpNum, corpInfo, userID = "")

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	String	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	corpInfo	CorpInfo	-	Y	회사 객체정보
CorpInfo 순번 변수명 타입 길이 필수 설명 1 ceoname String 100 Y 대표자 성명 2 corpName String 200 Y 회사명 3 addr String 300 Y 주소 4 bizType String 100 Y 업태 5 bizClass String 100 Y 종목
3	userID	String	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

6. RegistContact - 담당자 추가

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

def registContact(corpNum, contactInfo, userID = "")

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

7. GetContactInfo - 담당자 정보 확인

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

def getContactInfo(corpNum, contactID, userID = "")

요청

Parameters

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

응답

ContactInfo

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

예외

PopbillException

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

8. ListContact - 담당자 목록 확인

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

def listContact(corpNum, userID = "")

요청

Parameters

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

응답

ContactInfo

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

예외

PopbillException

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

9. UpdateContact - 담당자 정보 수정

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

def updateContact(corpNum, contactInfo, userID = "")

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

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

미리보기

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

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

def getAccessURL(corpNum, userID)

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

PopbillException

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