콘텐츠로 이동

회원 관리

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

섹션 제목: “1. CheckIsMember - 연동회원 가입여부 확인”
GET https://popbill-test.linkhub.co.kr/Join
  • 사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
2Accept-EncodingN
응답 압축 방식
  • gzip
Query 파라미터
순번 변수명 타입 길이 필수 설명
1CorpNumstring10Y
팝빌회원 사업자번호 ('-' 제외)
2LIDstring-Y
팝빌에서 발급한 링크아이디
요청 예시
curl --request GET \
--url 'https://{domain}/Join?CorpNum={CorpNum}&LID={LID}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 0 미가입
  • 1 가입
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "가입"
}

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

섹션 제목: “2. CheckID - 연동회원 아이디 중복 확인”
GET https://popbill-test.linkhub.co.kr/IDCheck
  • 사용하고자 하는 아이디의 중복여부를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
2Accept-EncodingN
응답 압축 방식
  • gzip
Query 파라미터
순번 변수명 타입 길이 필수 설명
1IDstring50Y
중복여부를 확인할 아이디
요청 예시
curl --request GET \
--url 'https://{domain}/IDCheck?ID={ID}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 0 미사용
  • 1 사용
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "해당아이디는 사용중 입니다."
}
POST https://popbill-test.linkhub.co.kr/Join
  • 프로그램 공급사의 고객사를 팝빌 연동회원으로 가입하는 API 입니다.

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

Request

요청 헤더
순번 변수명 필수 설명
1Content-TypeY
요청 본문 형식
  • application/json
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
요청 본문
순번 변수명 타입 길이 필수 설명
1IDstring50Y
아이디
6자 이상 50자 이하
2Passwordstring20Y
비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
3LinkIDstring20Y
파트너 링크아이디
팝빌에서 발급한 링크아이디
4CorpNumstring10Y
사업자번호 ('-' 제외)
5CEONamestring100Y
대표자 성명
6CorpNamestring200Y
회사명
7Addrstring300Y
사업장 주소
8BizTypestring100Y
업태
9BizClassstring100Y
종목
10ContactNamestring100Y
담당자 성명
11ContactEmailstring100Y
담당자 메일
12ContactTELstring20Y
담당자 휴대폰
요청 예시
curl --request POST \
--url 'https://{domain}/Join' \
--header 'Content-Type: application/json' \
--data '{
"ID": "test",
"Password": "test",
"LinkID": "TESTER",
"CorpNum": "1234567890",
"CEOName": "대표자명",
"CorpName": "회사명",
"Addr": "주소",
"BizType": "업태",
"BizClass": "종목",
"ContactName": "담당자명",
"ContactEmail": "test@test.com",
"ContactTEL": "01012345678"
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "가입 완료"
}
POST https://popbill-test.linkhub.co.kr/QuitRequest
  • 팝빌 연동회원을 탈퇴 처리합니다.
  • 관리자를 포함한 모든 담당자가 일괄 삭제 처리됩니다.

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

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Content-TypeY
요청 본문 형식
  • application/json
3Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
4Accept-EncodingN
응답 압축 방식
  • gzip
5X-PB-UserIDN
팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
1quitReasonstring200Y
회원 탈퇴 사유
요청 예시
curl --request POST \
--url 'https://{domain}/QuitRequest' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"quitReason": "회원 탈퇴 사유"
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "신청 완료"
}
GET https://popbill-test.linkhub.co.kr/CorpInfo
  • 연동회원의 회사정보를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
요청 예시
curl --request GET \
--url 'https://{domain}/CorpInfo' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1ceonamestring100
대표자 성명
2corpNamestring200
회사명
3addrstring300
주소
4bizTypestring100
업태
5bizClassstring100
종목
응답 예시
{
"ceoname": "대표자명",
"corpName": "회사명",
"addr": "주소",
"bizType": "업태",
"bizClass": "종목"
}
POST https://popbill-test.linkhub.co.kr/CorpInfo
  • 연동회원의 회사정보를 수정합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Content-TypeY
요청 본문 형식
  • application/json
3Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
4Accept-EncodingN
응답 압축 방식
  • gzip
5X-PB-UserIDN
팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
1ceonamestring100Y
대표자 성명
2corpNamestring200Y
회사명
3addrstring300Y
주소
4bizTypestring100Y
업태
5bizClassstring100Y
종목
요청 예시
curl --request POST \
--url 'https://{domain}/CorpInfo' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"ceoname": "대표자명",
"corpName": "회사명",
"addr": "주소",
"bizType": "업태",
"bizClass": "종목"
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "수정 완료"
}
POST https://popbill-test.linkhub.co.kr/IDs/New
  • 연동회원에 담당자를 추가합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Content-TypeY
요청 본문 형식
  • application/json
3Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
4Accept-EncodingN
응답 압축 방식
  • gzip
5X-PB-UserIDN
팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
1idstring50Y
아이디
6자 이상 50자 이하
2passwordstring20Y
비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
3personNamestring100Y
담당자 성명
4telstring20Y
담당자 휴대폰
5emailstring100Y
담당자 메일
6searchRolenumber1N
권한
  • 1 개인권한
  • 2 읽기권한
  • 3 회사권한 : 기본값
요청 예시
curl --request POST \
--url 'https://{domain}/IDs/New' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"id": "test",
"password": "test",
"personName": "담당자명",
"tel": "01012345678",
"email": "test@test.com"
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "추가 완료"
}

8. GetContactInfo - 담당자 정보 확인

섹션 제목: “8. GetContactInfo - 담당자 정보 확인”
POST https://popbill-test.linkhub.co.kr/Contact
  • 연동회원에 추가된 담당자 정보를 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Content-TypeY
요청 본문 형식
  • application/json
3Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
4Accept-EncodingN
응답 압축 방식
  • gzip
5X-PB-UserIDN
팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
1idstring50Y
담당자 아이디
요청 예시
curl --request POST \
--url 'https://{domain}/Contact' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"id": "test"
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1idstring50
담당자 아이디
2personNamestring100
담당자 성명
3telstring20
담당자 휴대폰
4emailstring100
담당자 메일
5regDTstring14
등록일시
형식 : yyyyMMddHHmmss
6searchRolenumber1
권한
  • 1 개인권한
  • 2 읽기권한
  • 3 회사권한
7mgrYNboolean-
역할
  • true 관리자
  • false 담당자
팝빌 사이트 [ 마이페이지 > 회사정보 > 담당자 관리 ] 메뉴에서 수정 가능
8statenumber1
계정상태
  • 1 사용중
응답 예시
{
"id": "test",
"personName": "담당자명",
"tel": "010-1234-5678",
"email": "test@test.com",
"regDT": "20250711112027",
"mgrYN": true,
"state": 1,
"searchRole": 3
}
GET https://popbill-test.linkhub.co.kr/IDs
  • 연동회원에 추가된 담당자 목록을 확인합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
요청 예시
curl --request GET \
--url 'https://{domain}/IDs' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1idstring50
담당자 아이디
2personNamestring100
담당자 성명
3telstring20
담당자 휴대폰
4emailstring100
담당자 메일
5regDTstring14
등록일시
형식 : yyyyMMddHHmmss
6searchRolenumber1
권한
  • 1 개인권한
  • 2 읽기권한
  • 3 회사권한
7mgrYNboolean-
역할
  • true 관리자
  • false 담당자
팝빌 사이트 [ 마이페이지 > 회사정보 > 담당자 관리 ] 메뉴에서 수정 가능
8statenumber1
계정상태
  • 1 사용중
응답 예시
[
{
"id": "test",
"personName": "담당자명",
"tel": "010-1234-5678",
"email": "test@test.com",
"regDT": "20250711112027",
"mgrYN": true,
"state": 1,
"searchRole": 3
}
]

10. UpdateContact - 담당자 정보 수정

섹션 제목: “10. UpdateContact - 담당자 정보 수정”
POST https://popbill-test.linkhub.co.kr/IDs
  • 연동회원에 추가된 담당자 정보를 수정합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Content-TypeY
요청 본문 형식
  • application/json
3Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
4Accept-EncodingN
응답 압축 방식
  • gzip
5X-PB-UserIDN
팝빌회원 아이디
요청 본문
순번 변수명 타입 길이 필수 설명
1idstring50Y
아이디
6자 이상 50자 이하
2personNamestring100Y
담당자 성명
3telstring20Y
담당자 휴대폰
4emailstring100Y
담당자 메일
5searchRolenumber1N
권한
  • 1 개인권한
  • 2 읽기권한
  • 3 회사권한 : 기본값
요청 예시
curl --request POST \
--url 'https://{domain}/IDs' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"id": "test",
"personName": "담당자명",
"tel": "01012345678",
"email": "test@test.com",
"searchRole": 3
}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "수정 완료"
}
POST https://popbill-test.linkhub.co.kr/Contact/Delete
  • 연동회원에 추가된 담당자를 삭제합니다.

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDY
팝빌회원 아이디
관리자만 요청 가능
Query 파라미터
순번 변수명 타입 길이 필수 설명
1ContactIDstring50Y
삭제할 담당자 아이디
관리자는 삭제 불가
요청 예시
curl --request POST \
--url 'https://{domain}/Contact/Delete?ContactID={ContactID}' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1codenumber-
API 처리에 대한 응답코드
  • 1 성공
2messagestring-
API 처리에 대한 응답메시지
응답 예시
{
"code": 1,
"message": "삭제 완료"
}

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

섹션 제목: “12. GetAccessURL - 팝빌 로그인 팝업 URL”
GET https://popbill-test.linkhub.co.kr/Member

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

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

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

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

Request

요청 헤더
순번 변수명 필수 설명
1AuthorizationY
2Accept-LanguageN
응답 언어 설정
  • ko-KR 기본값
  • en-US
3Accept-EncodingN
응답 압축 방식
  • gzip
4X-PB-UserIDN
팝빌회원 아이디
Query 파라미터
순번 변수명 타입 길이 필수 설명
1TGstring-Y
고정값 : LOGIN
요청 예시
curl --request GET \
--url 'https://{domain}/Member?TG=LOGIN' \
--header 'Authorization: Bearer {token}'

Response

응답 본문
순번 변수명 타입 길이 설명
1urlstring-
팝빌 로그인 팝업 URL
응답 예시
{
"url": "https://test.popbill.com/App/API?T=FFXMY6SEHFVDD27TUYBESQ7...XYK2NPF5NLWKD2==="
}