사전 준비
팝빌 Webhook 서비스를 사용하기 위한 사전 준비사항을 안내합니다.
고객사는 Callback URL 을 팝빌에 설정한 다음에 [튜토리얼] 진행이 필요합니다.
Webhook 통신 (팝빌→고객사 서버)
고객사 서버에서 웹훅을 전송 받기 위해서는 사전에 고객사 방화벽에 팝빌 Source IP와 Port를 허용해야만 합니다.
Source IP | Destination | Port |
---|---|---|
54.180.62.221 13.124.72.158 |
프로그램 공급사 수신용 IP/Domain | 80, 443, 9854 |
Callback URL 등록
팝빌에서 발생하는 이벤트 정보를 고객사 서버에서 실시간 전송받기 위해서는 콜백 URL이 팝빌로 사전에 등록되어 있어야 합니다. [Callback URL 유형] 에 따라 등록방법이 달라지며 고객사가 팝빌 사이트에 직접 등록해야 하는 "개별 URL" 유형과 고객사가 팝빌 메일로 요청하여 등록하는 “통합 URL” 유형을 제공합니다.
- [회원유형] 이 “단독형”인 경우 고객사가 직접 관리 가능한 개별 URL 유형을 이용한 등록을 권장합니다.
- 웹훅 사용이 필요한 API 상품 마다 별도의 Callback URL 등록이 필요합니다.
- URL 유형 변경을 원하는 경우 선행적으로 팝빌에 등록된 기존 URL 정보 해지를 요청하여 주시기 바랍니다.
1. 개별 URL 등록
단일 회원(사업자번호 기준)에서 발생된 이벤트를 전송 받기 위한 Callback URL을 팝빌 사이트에서 고객사가 직접 등록합니다.
설정 경로팝빌 테스트 사이트(test.popbill.com) 로그인 > API 상품 선택 > Webhook 관리 > Webhook 등록 메뉴로 이동
팝빌은 테스트와 운영 환경이 모두 독립적으로 구성되어 있기 때문에 각 환경의 설정이 호환되지 않습니다.
고객사는 운영(Production) 전환 이후에 팝빌 사이트(www.popbill.com) 에 Callback URL 등록이 필요합니다.
![Webhook Callback URL 등록하는 이미지](/images/webhook/url-regist.png)
① Webhook 유형
팝빌에서는 고객사 서버의 콜백 URL로 전송하는 웹훅 방식으로 REST를 기본으로 지원하고 있습니다.
REST 외 방식(망분리 환경 또는 SAP 등)에 대한 지원은 팝빌 기술지원센터(1600-9854)로 문의하여 주시기 바랍니다.
② 콜백 URL
발생한 이벤트 정보를 실시간으로 전송받기 위한 고객사 서버의 URL 정보를 입력합니다.
작성예시> https://www.linkhub.co.kr/popbill.callback
③ Webhook 인증 (선택)
고객사의 웹훅 수신 서버에 강화된 보안 설정을 적용하기 위한 HTTP 인증으로, 고객사의 운영방식에 따라 선택하여 추가로 적용합니다. Webhook 인증은 미사용이 기본값으로 팝빌에서는 Basic과 API Key 인증방식을 지원하고 있습니다.
Webhook 인증 | 입력 정보 | 인코딩 여부 | 요청 헤더 |
---|---|---|---|
미사용(기본값) | - | X | - |
Basic | User ID와 Password | Base64 | Request Header- "Authorization" 항목으로 전송 |
API Key | API Key | X | Request Header- "X-Api-Key" 항목으로 전송 |
Basic 또는 API Key 외 인증방식에 대한 문의는 팝빌 기술지원센터(1600-9854)로 연락하여 주시기 바랍니다.
2. 통합 URL 등록
다수 고객사(사업자번호 기준)에서 발생된 이벤트를 하나의 서버로 전송 받기 위한 Callback URL 입니다. 고객사의 요청사항을 팝빌에서 메일로 접수 받아 등록되며, 등록결과는 고객사에게 메일로 회신드립니다.
- 1. 접수메일: partner@linkhubcorp.com / 문의 : 파트너센터 1600-8536
- 2. 제목 : [업체명] 통합URL 적용 요청합니다.
-
3. 메일 내용
-
신청자 정보
- 사업자번호
- 팝빌 ID
- 담당자 성명/연락처
-
접수 내용
- 적용 일자
- 웹훅 이용 환경 : 테스트 또는 운영(Production) 선택하여 기재
- 웹훅 유형 : REST
- 콜백 URL
- 웹훅 인증(선택) : Basic 또는 API Key 선택하여 기재 ※기본값: 미사용
-
신청자 정보
Ex) 접수 내용 메일
![접수 내용 메일 예시](/images/webhook/mail-example.png)
Basic 또는 API Key 외 인증방식에 대한 문의는 팝빌 기술지원센터(1600-9854)로 연락하여 주시기 바랍니다.