튜토리얼

Java 개발환경에서 팝빌 SDK를 추가하고, 현금영수증 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 Java SDK를 추가하기 위해 Spring 프로젝트 "pom.xml" 파일에 팝빌 Java SDK dependency 정보를 추가하고 Maven 업데이트합니다.

<dependency>
    <groupId>kr.co.linkhub</groupId>
    <artifactId>popbill-sdk</artifactId>
    <version>1.69.0</version>
</dependency>

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.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
http://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"/>

  <!--
  <테스트 연동개발 준비사항>
    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>
    <!-- 현금영수증 서비스 객체 초기화  -->
    <beans:bean id="cashbillService" class="com.popbill.api.cashbill.CashbillServiceImp">
      <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. RegistIssue 기능 구현

① 서비스 클래스 빈 객체 추가를 위해 @Autowired 어노테이션과 RegistIssue 함수 호출 코드를 추가합니다.

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.CashbillService;
import com.popbill.api.PopbillException;
import com.popbill.api.CBIssueResponse;
import com.popbill.api.cashbill.Cashbill;

@Controller
@RequestMapping(value = "CashbillService")
public class CashbillServiceExample {

    @Autowired
    private CashbillService cashbillService;

    @RequestMapping(value = "registIssue", method = RequestMethod.GET)
    public String registIssue(Model m) {

        // 팝빌회원 사업자번호
        String CorpNum = "1234567890";

        // 현금영수증 정보
        Cashbill cashbill = new Cashbill();

        // 문서번호, 1~24자리 (숫자, 영문, '-', '_') 조합으로 사업자 별로 중복되지 않도록 구성
        cashbill.setMgtKey("20250711-MVC001");

        // 거래일시, 날짜(yyyyMMddHHmmss)
        // 당일, 전일만 가능
        cashbill.setTradeDT("20250711111111");

        // 문서형태, 승인거래 기재
        cashbill.setTradeType("승인거래");

        // 거래구분, {소득공제용, 지출증빙용} 중 기재
        cashbill.setTradeUsage("소득공제용");

        // 거래유형, {일반, 도서공연, 대중교통} 중 기재
        // 도서공연 : 도서, 공연, 박물관, 미술관, 수영장, 체력단련장, 신문구독료(종이신문), 영화관람료
        // - 미입력시 기본값 "일반" 처리
        cashbill.setTradeOpt("대중교통");

        // 과세형태, {과세, 비과세} 중 기재
        cashbill.setTaxationType("과세");

        // 거래금액, 숫자만 가능, 봉사료 + 공급가액 + 부가세
        cashbill.setTotalAmount("11000");

        // 공급가액, 숫자만 가능
        cashbill.setSupplyCost("10000");

        // 부가세, 양수 또는 0 입력
        cashbill.setTax("1000");

        // 봉사료, 양수 또는 0 입력
        cashbill.setServiceFee("0");

        // 가맹점 사업자번호, '-'제외 10자리
        cashbill.setFranchiseCorpNum("1234567890");

        // 가맹점 종사업장 식별번호
        cashbill.setFranchiseTaxRegID("");

        // 가맹점 상호
        cashbill.setFranchiseCorpName("가맹점 상호");

        // 가맹점 대표자 성명
        cashbill.setFranchiseCEOName("가맹점 대표자");

        // 가맹점 주소
        cashbill.setFranchiseAddr("가맹점 주소");

        // 가맹점 전화번호
        cashbill.setFranchiseTEL("07043042991");

        // 식별번호, 거래구분에 따라 작성
        // └ 소득공제용 - 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 입력
        // └ 지출증빙용 - 사업자번호/휴대폰/카드번호 입력
        // └ 주민등록번호 13자리, 휴대폰번호 10~11자리, 카드번호 13~19자리, 사업자번호 10자리 입력 가능
        cashbill.setIdentityNum("0101112222");

        // 구매자(고객) 성명
        cashbill.setCustomerName("고객명");

        // 주문 상품명
        cashbill.setItemName("상품명");

        // 주문번호
        cashbill.setOrderNumber("주문번호");

        // 구매자(고객) 메일
        // 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
        // 실제 거래처의 메일주소가 기재되지 않도록 주의
        cashbill.setEmail("test@test.com");

        // 구매자(고객) 휴대폰
        // - {smssendYN} 의 값이 true 인 경우 아래 휴대폰번호로 안내 문자 전송
        cashbill.setHp("");

        // 구매자 알림문자 전송 여부
        cashbill.setSmssendYN(false);

        // 현금영수증 상태 이력을 관리하기 위한 메모
        String Memo = "현금영수증 즉시발행 메모";

        // 팝빌회원 아이디
        String UserID = "testkorea";

        // 현금영수증 발행 안내메일 제목, 미기재시 기본 양식으로 메일 전송
        String EmailSubject = "";

        try {

            CBIssueResponse response = cashbillService.registIssue(CorpNum, cashbill, Memo,
                UserID, EmailSubject);

            m.addAttribute("Response", response);

        } 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>code (응답코드) : ${Response.code}</p>
    <p>message (응답메시지) : ${Response.message}</p>
    <p>confirmNum (국세청승인번호) : ${Response.confirmNum}</p>
    <p>tradeDate (거래일자) : ${Response.tradeDate}</p>
  </body>
</html>

4. API 응답결과 확인

API 호출 응답결과는 다음과 같습니다.

구분	응답
성공	code : 1
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지