튜토리얼 - SpringBoot
Java 개발환경에서 팝빌 SDK를 추가하고, 기업정보조회 (CheckBizInfo) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
1. POPBiLL SDK 추가
섹션 제목: “1. POPBiLL SDK 추가”Popbill SpringBoot Starter 추가를 위해 SpringBoot 프로젝트 “build.gradle” 파일에 dependency를 추가 후 Refresh 합니다.
※ Popbill SpringBoot Starter는 SpringBoot v1.0 이상에서 사용 가능하며 Popbill Java SDK AutoConfiguration을 지원합니다.
dependencies { implementation 'kr.co.linkhub:popbill-spring-boot-starter:1.20.4'}2. POPBiLL SDK 설정
섹션 제목: “2. POPBiLL SDK 설정”SDK 설정을 위해 아래의 코드를 application.yml 파일에 추가합니다.
popbill: # API Key # - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성) # • LinkID: 파트너를 식별하기 위한 고유 식별자 # • SecretKey: API 인증토큰 발급에 사용되는 키 # # TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요. linkId: TESTER secretKey: SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I= # 연동환경(테스트/운영) 설정 # - 연동환경을 테스트 또는 운영으로 설정합니다. # • true: 테스트 환경으로 설정 # • false(default) : 운영 환경으로 설정 # # ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다. isTest: true # 인증토큰 IP 일치 검증 사용 여부 # - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다. # (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치) # • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용 # • false(미사용) : IP 일치 검사를 생략 # # ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용 # 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경 isIpRestrictOnOff: true # 통신 IP 고정 여부 # - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다. # • true(사용) : 고정(Static) IP 사용 # • false(미사용, default) : 가변(Elastic) IP 사용 # # ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다. # (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능) useStaticIp: false # 로컬시스템 시간 사용 여부 # - 현재시각 기준을 설정합니다. # • true(사용, default) : 로컬시스템 시간 사용 # • false(미사용) : 팝빌 서버의 시간을 사용 # # ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다. # ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다. # ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나 # 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다. useLocalTimeYn: true3. CheckBizInfo 기능 구현
섹션 제목: “3. CheckBizInfo 기능 구현”① 기업정보조회 서비스 클래스 빈 객체 추가를 위해 @Autowired 어노테이션과 CheckBizInfo 함수 호출 코드를 추가합니다.
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;
import com.popbill.api.BizInfoCheckService;import com.popbill.api.BizCheckInfo;import com.popbill.api.PopbillException;
@Controllerpublic class BizInfoCheckServiceController {
@Autowired private BizInfoCheckService bizInfoCheckService;
@RequestMapping(value = "checkBizInfo", method = RequestMethod.GET) public String checkBizInfo(Model m) {
// 팝빌회원 사업자번호 String CorpNum = "1234567890";
// 조회할 사업자번호 String CheckCorpNum = "6798700433";
// 팝빌회원 아이디 String UserID = "testkorea";
try {
BizCheckInfo bizInfo = bizInfoCheckService.CheckBizInfo(CorpNum, CheckCorpNum, UserID);
m.addAttribute("BizInfo", bizInfo);
} catch (PopbillException e) { // 예외 발생 시, e.getCode() 로 오류 코드를 확인하고, e.getMessage()로 오류 메시지를 확인합니다. System.out.println("오류 코드" + e.getCode()); System.out.println("오류 메시지" + e.getMessage()); }
return "response"; }}② 함수 호출결과 코드와 메시지를 출력하는 response.html 파일을 추가합니다.
<html xmlns:th="http://www.thymeleaf.org"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <title>Popbill SDK Response</title> </head> <body> <fieldset> <ul> <li>corpNum (사업자번호) : <span th:text="${BizInfo.corpNum}"></span></li> <li>companyRegNum (법인등록번호): <span th:text="${BizInfo.companyRegNum}"></span></li> <li>checkDT (기업정보조회일시) : <span th:text="${BizInfo.checkDT}"></span></li> <li>corpName (상호): <span th:text="${BizInfo.corpName}"></span></li> <li>CEOName (대표자명) : <span th:text="${BizInfo.CEOName}"></span></li> <li>corpCode (기업형태코드): <span th:text="${BizInfo.corpCode}"></span></li> <li>corpScaleCode (기업규모코드): <span th:text="${BizInfo.corpScaleCode}"></span></li> <li>personCorpCode (개인/법인코드): <span th:text="${BizInfo.personCorpCode}"></span></li> <li>headOfficeCode (본점/지점코드) : <span th:text="${BizInfo.headOfficeCode}"></span></li> <li>industryCode (산업코드) : <span th:text="${BizInfo.industryCode}"></span></li> <li>establishDate (설립일자) : <span th:text="${BizInfo.establishDate}"></span></li> <li>establishCode (설립코드) : <span th:text="${BizInfo.establishCode}"></span></li> <li>workPlaceCode (사업장코드): <span th:text="${BizInfo.workPlaceCode}"></span></li> <li>addrCode (주소코드) : <span th:text="${BizInfo.addrCode}"></span></li> <li>zipCode (우편번호) : <span th:text="${BizInfo.zipCode}"></span></li> <li>addr (주소) : <span th:text="${BizInfo.addr}"></span></li> <li>addrDetail (상세주소) : <span th:text="${BizInfo.addrDetail}"></span></li> <li>enAddr (영문주소) : <span th:text="${BizInfo.enAddr}"></span></li> <li>bizClass (업종) : <span th:text="${BizInfo.bizClass}"></span></li> <li>bizType (업태) : <span th:text="${BizInfo.bizType}"></span></li> <li>result (상태코드) : <span th:text="${BizInfo.result}"></span></li> <li>resultMessage (상태메시지) : <span th:text="${BizInfo.resultMessage}"></span></li> <li>closeDownState (휴폐업상태) : <span th:text="${BizInfo.closeDownState}"></span></li> <li>closeDownStateDate (휴폐업일자) : <span th:text="${BizInfo.closeDownStateDate}"></span></li> <li>closeDownTaxType (과세유형) : <span th:text="${BizInfo.closeDownTaxType}"></span></li> <li>closeDownTaxTypeDate (과세유형 전환일자): <span th:text="${BizInfo.closeDownTaxTypeDate}"></span></li> </ul> </fieldset> </body></html>4. API 응답결과 확인
섹션 제목: “4. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | result(상태코드) : 100 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |