POPBill Developers
가이드

SDK 환경설정

팝빌 SDK에는 프로그램 공급사의 개발환경을 지원하기 위한 별도의 Config 값이 존재하며, 개발환경에 따라 변수 값을 변경하여 팝빌 API를 이용할 수 있습니다.

<!--
<테스트 연동개발 준비사항>
    1) API Key 변경 (연동신청 시 메일로 전달된 정보)
        - LinkID : 링크허브에서 발급한 링크아이디
        - SecretKey : 링크허브에서 발급한 비밀키
    2) SDK 환경설정 옵션 설정
        - IsTest : 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
        - IPRestrictOnOff : 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
        - UseStaticIP : 통신 IP 고정, true-사용, false-미사용, (기본값:false)
        - UseLocalTimeYN : 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
-->
<util:properties id="EXAMPLE_CONFIG">
  <beans:prop key="LinkID">TESTER</beans:prop>
  <beans:prop key="SecretKey">SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=</beans:prop>
  <beans:prop key="IsTest">true</beans:prop>
  <beans:prop key="IsIPRestrictOnOff">true</beans:prop>
  <beans:prop key="UseStaticIP">false</beans:prop>
  <beans:prop key="UseLocalTimeYN">true</beans:prop>
</util:properties>
<beans:beans>
  <!-- 예금주조회 Service Implementation Bean registration.  -->
  <beans:bean id="accountCheckService" class="com.popbill.api.accountcheck.AccountCheckServiceImp">
      <beans:property name="linkID" value="#{EXAMPLE_CONFIG.LinkID}"/>
      <beans:property name="secretKey" value="#{EXAMPLE_CONFIG.SecretKey}"/>
      <beans:property name="test" value="#{EXAMPLE_CONFIG.IsTest}"/>
      <beans:property name="IPRestrictOnOff" value="#{EXAMPLE_CONFIG.IsIPRestrictOnOff}"/>
      <beans:property name="useStaticIP" value="#{EXAMPLE_CONFIG.UseStaticIP}"/>
      <beans:property name="useLocalTimeYN" value="#{EXAMPLE_CONFIG.UseLocalTimeYN}"/>
  </beans:bean>
</beans:beans>

1. 테스트 ↔ 운영(PROD) 전환 설정 – IsTest

팝빌은 테스트와 운영 환경을 독립적으로 지원하며 IsTest 변수를 이용하여 자유롭게 환경 전환(테스트↔운영)이 가능합니다.

구분 테스트 운영(Production)
IsTest true (기본값) false
URL https://test.popbill.com https://www.popbill.com
국세청신고 가상으로 처리 실제 국세청 신고
API Key

동일한 API Key (LinkID/SecretKey) 사용

※ 테스트와 운영 환경을 구별하여 API Key 사용이 필요한 경우 별도 협의가 필요합니다.

운영 전환을 위한 SDK 환경설정 변경 방법
  • Java(Spring) SDK
    1. "servlet-contect.xml" 파일의 IsTest Property 값을 "true" 에서 "false" 로 변경합니다.
  • Java(JSP) SDK
    1. "common.jsp" 파일의 test Property 값을 "true" 에서 "false" 로 변경합니다.
  • Java(SpringBoot) SDK
    1. "application.yml" 파일의 isTest Property 값을 "true" 에서 "false" 로 변경합니다.

팝빌 운영 전환은 제반사항(계약, 결제 등)에 대해 사전 협의가 필요합니다. [운영(PROD) 전환신청]

2. 인증 토큰 IP 설정 – IsIPRestrictOnOff

팝빌 API를 이용하기 위해서는 팝빌 인증서버로부터 Bearer Token 발급이 필요하며, 발급된 Token으로만 API 함수 호출이 가능합니다. 제 3자의 스누핑/스니핑에 의한 오사용 및 제반 사고를 방지하기 위해 팝빌 시스템은 Bearer Token 발급을 요청한 IP와 API를 호출하는 IP의 일치 여부를 검증하고 있으며, IsIPRestrictOnOff 변수에 따라 사용 여부를 설정할 수 있습니다.

구분 true (기본값) false
IsIPRestrictOnOff 인증 요청 IP↔API 호출 IP 일치 검증 인증 요청 IP↔API 호출 IP 일치 검증 생략
링크허브 인증토큰 발급 과정

3. 통신 IP 고정(방화벽 지원) – UseStaticIP

고객사 보안정책(방화벽 설정 등)으로 인해 Outbound Traffic(고객사→팝빌)의 고정 IP 설정이 필요한 경우, 팝빌 SDK 설정의 UseStaticIP 변수 값의 변경이 필요합니다. IP 주소 및 URL 확인

구분 true false (기본값)
UseStaticIP 고정 IP 사용 유동 IP 사용