API 연동절차

팝빌 API 연동을 위한 절차를 안내합니다.

팝빌은 개발 및 테스트를 위한 실제 서비스와 동일한 구조로 구성된 테스트 환경을 제공합니다. [연동환경]

1. 연동신청

API Key 발급을 위해 팝빌에 연동을 신청합니다. [연동신청]

상세 절차

1. 연동신청이 완료되면 팝빌 담당자가 API 상품 및 서비스 연동 방법을 안내합니다.
2. 연동을 신청한 프로그램 공급사를 파트너로 등록합니다.
3. 팝빌은 API Key 발급 및 테스트 환경 계정 정보를 메일로 전달합니다.
   ※ 테스트 환경 계정정보는 연동신청에 입력한 계정정보와 동일합니다.

2. API Key 설정

파트너는 발급받은 API Key(LinkID, SecretKey)를 설정합니다.

상세 절차

1. 팝빌에서 발급받은 API Key(LinkID, SecretKey)를 확인합니다.

   • 링크아이디(LinkID) : 파트너를 식별하는 고유 ID
   • 비밀키(SecretKey) : API 호출 시 인증을 위한 키

2. 연동 방식에 따라 아래 중 하나를 선택해 진행합니다.

   • SDK로 연동하는 경우 : 발급받은 API Key를 SDK에 설정합니다. [SDK 환경설정]
   • API를 직접 호출하는 경우 : 발급받은 API Key를 이용하여 인증토큰을 발급 받습니다. [인증]

API Key는 외부 노출 시 보안상 문제가 발생할 수 있으므로, 외부에 공개되지 않도록 각별히 주의해 주시기 바랍니다.

3. 개발 및 테스트

SDK 또는 API 레퍼런스를 참고하여 테스트 환경(Sandbox)에서 팝빌 API 연동을 구현합니다.
API 호출, 응답 처리, 오류 상황 등을 사전에 확인하여 운영 환경(Production) 적용 전에 연동 기능을 검증할 수 있습니다.

SDK 레퍼런스 참고 자료

• [SDK 레퍼런스]
• [SDK+Example 다운로드]

API 레퍼런스 참고 자료

• [API 레퍼런스]

공통 참고 자료

• [팝빌 테스트 사이트 - https://test.popbill.com]
  → 테스트 사이트 제공항목 : 파트너 화면 UI/UX 구성 참고, API 이용내역 및 처리결과 확인

4. 운영전환

개발 및 테스트를 완료한 후 운영(Production) 환경으로 전환 신청을 진행합니다. [운영전환 신청]

상세 절차

1. 팝빌 기업연동 담당자가 운영전환을 위한 제반사항을 유선으로 파트너와 협의합니다.
2. 팝빌은 운영전환 절차 및 설정 방법을 안내하는 메일을 파트너에게 발송합니다.
3. 연동 방식에 따라 운영환경을 설정합니다.
   • SDK로 연동하는 경우 : 파트너는 SDK 환경설정의 IsTest 설정값을 변경한 뒤, 운영환경에서 서비스를 이용합니다.
     [연동환경(테스트/운영) 설정]
   • API를 직접 호출하는 경우 : 운영환경 호출을 위한 도메인 및 ServiceID 를 변경하여 호출합니다.
     [연동환경(테스트/운영) 설정]

팝빌 테스트 환경과 운영 환경은 독립적인 시스템으로 구성되어 운영전환시 데이터 이관 또는 공유가 불가합니다.
운영 환경 이용 전 필요한 사전 준비를 완료해 주시기 바랍니다. 단, 사전 준비가 불필요한 서비스는 즉시 이용 가능합니다.