튜토리얼 - SpringMVC
Java 개발환경에서 팝빌 SDK를 추가하고, 홈택스 전자세금계산서 수집요청 (RequestJob) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
1. POPBiLL SDK 추가
섹션 제목: “1. POPBiLL SDK 추가”팝빌 Java SDK를 추가하기 위해 Spring 프로젝트 “pom.xml” 파일에 팝빌 Java SDK dependency 정보를 추가하고 Maven 업데이트합니다.
<dependency> <groupId>kr.co.linkhub</groupId> <artifactId>popbill-sdk</artifactId> <version>1.71.4</version></dependency>2. POPBiLL SDK 설정
섹션 제목: “2. POPBiLL SDK 설정”홈택스수집(세금) 클래스를 Spring 빈으로 추가합니다. 아래의 코드를 참조하여 “servlet-context.xml” 파일을 수정합니다.
<?xml version="1.0" encoding="UTF-8"?><beans:beans xmlns="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:beans="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsdhttp://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">
<annotation-driven/>
<resources mapping="/resources/**" location="/resources/"/>
<beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <beans:property name="prefix" value="/WEB-INF/views/"/> <beans:property name="suffix" value=".jsp"/> </beans:bean>
<context:component-scan base-package="com.popbill.example"/>
<util:properties id="EXAMPLE_CONFIG"> <!-- API Key - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성) • LinkID: 파트너를 식별하기 위한 고유 식별자 • SecretKey: API 인증토큰 발급에 사용되는 키
TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요. --> <beans:prop key="LinkID">TESTER</beans:prop> <beans:prop key="SecretKey">SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=</beans:prop> <!-- 연동환경(테스트/운영) 설정 - 연동환경을 테스트 또는 운영으로 설정합니다. • true: 테스트 환경으로 설정 • false(default) : 운영 환경으로 설정
※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다. --> <beans:prop key="IsTest">true</beans:prop> <!-- 인증토큰 IP 일치 검증 사용 여부 - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다. (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치) • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용 • false(미사용) : IP 일치 검사를 생략
※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경 --> <beans:prop key="IsIPRestrictOnOff">true</beans:prop> <!-- 통신 IP 고정 여부 - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다. • true(사용) : 고정(Static) IP 사용 • false(미사용, default) : 가변(Elastic) IP 사용
※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다. (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능) --> <beans:prop key="UseStaticIP">false</beans:prop> <!-- 로컬시스템 시간 사용 여부 - 현재시각 기준을 설정합니다. • true(사용, default) : 로컬시스템 시간 사용 • false(미사용) : 팝빌 서버의 시간을 사용
※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다. ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다. ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다. --> <beans:prop key="UseLocalTimeYN">true</beans:prop> </util:properties>
<beans:beans> <!-- 홈택스수집(세금) 서비스 객체 초기화 --> <beans:bean id="htTaxinvoiceService" class="com.popbill.api.hometax.HTTaxinvoiceServiceImp"> <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></beans:beans>3. RequestJob 기능 구현
섹션 제목: “3. RequestJob 기능 구현”① 서비스 클래스 빈 객체 추가를 위해 @Autowired 어노테이션과 RequestJob 함수 호출 코드를 추가합니다.
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.HTTaxinvoiceService;import com.popbill.api.PopbillException;import com.popbill.api.hometax.QueryType;
@Controllerpublic class HTTaxinvoiceExample {
@Autowired private HTTaxinvoiceService htTaxinvoiceService;
@RequestMapping(value = "requestJob", method = RequestMethod.GET) public String requestJob(Model m) {
// 팝빌회원 사업자번호 String CorpNum = "1234567890";
// 전자세금계산서 유형, SELL-매출, BUY-매입, TRUSTEE-수탁 QueryType queryType = QueryType.SELL;
// 조회할 일자 유형, W-작성일자, I-발행일자, S-전송일자 String DType = "S";
// 검색 시작일자, 날짜형식(yyyyMMdd) String SDate = "20250711";
// 검색 종료일자, 닐짜형식(yyyyMMdd) String EDate = "20250731";
// 팝빌회원 아이디 String UserID = "testkorea";
try {
String jobID = htTaxinvoiceService.requestJob(CorpNum, queryType, DType, SDate, EDate, UserID);
m.addAttribute("Result", jobID);
} catch (PopbillException e) { // 예외 발생 시, e.getCode() 로 오류 코드를 확인하고, e.getMessage()로 오류 메시지를 확인합니다. System.out.println("오류 코드" + e.getCode()); System.out.println("오류 메시지" + e.getMessage()); }
return "response"; }}② 함수 호출결과 코드와 메시지를 출력하는 response.jsp 파일을 추가합니다.
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %><%@ page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%><html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <title>Popbill SDK Response</title> </head>
<body> <p>JobID (작업아이디) : ${Result}</p> </body></html>4. API 응답결과 확인
섹션 제목: “4. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | JobID(작업아이디) : 18자리 문자열 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |