회원 관리

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

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

Response CheckIsMember(string CorpNum, string LinkID)

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

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

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

Response CheckID(string ID)

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

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

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

Response JoinMember(JoinForm 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	long	-	API 처리에 대한 응답코드 1 성공
2	message	string	-	API 처리에 대한 응답메시지

예외

PopbillException

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

4. QuitMember - 연동회원 탈퇴

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

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

Response QuitMember(string CorpNum, string QuitReason, string UserID = null)

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

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

5. GetCorpInfo - 회사정보 확인

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

CorpInfo GetCorpInfo(string CorpNum, string UserID = null)

요청

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	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

6. UpdateCorpInfo - 회사정보 수정

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

Response UpdateCorpInfo(string CorpNum, CorpInfo corpInfo, string UserID = null)

요청

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	long	-	API 처리에 대한 응답코드 1 성공
2	message	string	-	API 처리에 대한 응답메시지

예외

PopbillException

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

7. RegistContact - 담당자 추가

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

Response RegistContact(string CorpNum, Contact contactInfo, string UserID = null)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	contactInfo	Contact	-	Y	담당자 객체정보
Contact 순번 변수명 타입 길이 필수 설명 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 int 1 N 권한 1 개인권한 2 읽기권한 3 회사권한 : 기본값
3	UserID	string	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

8. GetContactInfo - 담당자 정보 확인

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

Contact GetContactInfo(string CorpNum, string ContactID, string UserID = null)

요청

Parameters

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

응답

Contact

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

예외

PopbillException

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

9. ListContact - 담당자 목록 확인

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

List<Contact> ListContact(string CorpNum, string UserID = null)

요청

Parameters

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

응답

List<Contact>

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

예외

PopbillException

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

10. UpdateContact - 담당자 정보 수정

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

Response UpdateContact(string CorpNum, Contact contactInfo, string UserID = null)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	contactInfo	Contact	-	Y	담당자 객체정보
Contact 순번 변수명 타입 길이 필수 설명 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 int 1 N 권한 1 개인권한 2 읽기권한 3 회사권한 : 기본값
3	UserID	string	50	N	팝빌회원 아이디

응답

Response

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

예외

PopbillException

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

11. DeleteContact - 담당자 삭제

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

Response DeleteContact(String CorpNum, String ContactID, String UserID)

요청

Parameters

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

응답

Response

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

예외

PopbillException

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

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

미리보기

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

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

string GetAccessURL(string CorpNum, string UserID)

요청

Parameters

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

응답

string - 요청에 대한 응답 URL

예외

PopbillException

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