튜토리얼

Java 개발환경에서 팝빌 SDK를 추가하여 현금영수증 즉시 발행 (RegistIssue) 함수를 구현하는 예시입니다.

1. POPBiLL SDK 추가

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

<dependency>
    <groupId>kr.co.linkhub</groupId>
    <artifactId>popbill-sdk</artifactId>
    <version>1.66.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";

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

      // 현금영수증 객체 생성
      Cashbill cashbill = new Cashbill();

      // 문서번호
      // 문서 관리를 위해 파트너가 할당하는 식별번호
      // 1~24자리 영문 대소문자, 숫자, 특수문자('-','_')로 구성
      cashbill.setMgtKey("20250314-001");

      // 거래일시, 형식(yyyyMMddHHmmss)
      // 발행기준 전일부터 당일까지 입력 가능
      // 미입력시 기본값(발행일시) 처리됨
      cashbill.setTradeDT("20250319093919");

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

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

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

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

      // 거래유형, [일반, 도서공연, 대중교통] 중 기재
      cashbill.setTradeOpt("대중교통");

      // 공급가액
      cashbill.setSupplyCost("10000");

      // 부가세
      cashbill.setTax("1000");

      // 봉사료
      cashbill.setServiceFee("0");

      // 합계금액, 공급가액 + 부가세 + 봉사료
      cashbill.setTotalAmount("11000");

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

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

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

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

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

      // 가맹점 연락처
      cashbill.setFranchiseTEL("07043042991");

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

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

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

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

      // 구매자(고객) 휴대폰
      cashbill.setHp("010111222");

      // 구매자 알림문자 전송 여부
      // 알림문자 전송시 포인트가 차감되며, 전송실패시 환불처리됨
      cashbill.setSmssendYN(false);

      try {

          CBIssueResponse response = cashbillService.registIssue(corpNum, cashbill, Memo);

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

4. 결과 확인

함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 숫자 1 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]