튜토리얼 - SpringBoot

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

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 설정

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: true

3. RegistIssue 기능 구현

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

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

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.PopbillException;
import com.popbill.api.SMTIssueResponse;
import com.popbill.api.StatementService;
import com.popbill.api.statement.Statement;
import com.popbill.api.statement.StatementDetail;

@Controller
@RequestMapping(value = "StatementService")
public class StatementServiceController {

    @Autowired
    private StatementService statementService;

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

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

        // 전자명세서 정보
        Statement statement = new Statement();

        // 전자명세서 문서 유형, [121 - 거래명세서], [122 - 청구서], [123 - 견적서], [124 - 발주서], [125 - 입금표], [126 - 영수증]
        statement.setItemCode((short) 121);

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

        // 맞춤양식 코드, 미기재시 기본양식으로 처리
        statement.setFormCode("");

        // 작성일자, 형태 yyyyMMdd
        statement.setWriteDate("20250711");

        // 과세형태, {과세, 영세, 면세} 중 기재
        statement.setTaxType("과세");

        // 영수/청구, {영수, 청구, 없음} 중 기재
        statement.setPurposeType("영수");

        // 일련번호
        statement.setSerialNum("123");

        // 세액 합계
        statement.setTaxTotal("40000");

        // 공급가액 합계
        statement.setSupplyCostTotal("400000");

        // 합계금액. 공급가액 + 세액
        statement.setTotalAmount("440000");

        // 비고
        statement.setRemark1("비고1");
        statement.setRemark2("비고2");
        statement.setRemark3("비고3");

        /*********************************************************************
         *                           발신자 정보
         *********************************************************************/

        // 발신자 사업자번호
        statement.setSenderCorpNum("1234567890");

        // 발신자 종사업장 식별번호, 숫자 4자리, 필요시 기재
        statement.setSenderTaxRegID("");

        // 발신자 상호
        statement.setSenderCorpName("발신자 상호");

        // 발신자 대표자성명
        statement.setSenderCEOName("발신자 대표자성명");

        // 발신자 주소
        statement.setSenderAddr("발신자 주소");

        // 발신자 업태
        statement.setSenderBizType("업태");

        // 발신자 종목
        statement.setSenderBizClass("업종");

        // 발신자 성명
        statement.setSenderContactName("발신자 성명");

        // 발신자 부서명
        statement.setSenderDeptName("발신자 부서명");

        // 발신자 연락처
        statement.setSenderTEL("070-7070-0707");

        // 발신자 휴대전화
        statement.setSenderHP("010-000-2222");

        // 발신자 메일주소
        statement.setSenderEmail("test@test.com");

        // 발신자 팩스번호
        statement.setSenderFAX("");

        /*********************************************************************
         *                          수신자 정보
         *********************************************************************/

        // 수신자 사업자번호
        statement.setReceiverCorpNum("8888888888");

        // 수신자 종사업장 식별번호
        statement.setReceiverTaxRegID("");

        // 수신자 상호
        statement.setReceiverCorpName("수신자 상호");

        // 수신자 대표자성명
        statement.setReceiverCEOName("수신자 대표자성명");

        // 수신자 주소
        statement.setReceiverAddr("수신자 주소");

        // 수신자 업태
        statement.setReceiverBizType("수신자 업태");

        // 수신자 종목
        statement.setReceiverBizClass("수신자 종목");

        // 수신자 성명
        statement.setReceiverContactName("수신자 성명");

        // 수신자 부서명
        statement.setReceiverDeptName("수신자 부서명");

        // 수신자 연락처
        statement.setReceiverTEL("");

        // 수신자 휴대전화
        statement.setReceiverHP("");

        // 수신자 메일주소
        // 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
        // 실제 거래처의 메일주소가 기재되지 않도록 주의
        statement.setReceiverEmail("");

        // 수신자 팩스번호
        statement.setReceiverFAX("");

        // 팝빌에 등록된 사업자등록증 첨부 여부 (true / false 중 택 1)
        // └ true = 첨부 , false = 미첨부(기본값)
        // - 팝빌 사이트 또는 인감 및 첨부문서 등록 팝업 URL (GetSealURL API) 함수를 이용하여 등록
        statement.setBusinessLicenseYN(false);

        // 팝빌에 등록된 통장사본 첨부 여부 (true / false 중 택 1)
        // └ true = 첨부 , false = 미첨부(기본값)
        // - 팝빌 사이트 또는 인감 및 첨부문서 등록 팝업 URL (GetSealURL API) 함수를 이용하여 등록
        statement.setBankBookYN(false);

        // 알림문자 전송 여부
        statement.setSmssendYN(false);

        // 추가속성
        // 전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력
        Map<String, String> propertyBag = new HashMap<String, String>();

        propertyBag.put("Balance", "15000");            // 전잔액
        propertyBag.put("Deposit", "5000");             // 입금액
        propertyBag.put("CBalance", "20000");           // 현잔액

        statement.setPropertyBag(propertyBag);

        /*********************************************************************
         *                            전자명세서 품목항목
         *********************************************************************/

        statement.setDetailList(new ArrayList<StatementDetail>());

        StatementDetail detail = new StatementDetail();    // 상세항목(품목) 배열

        detail.setSerialNum((short) 1);                    // 일련번호, 1부터 순차기재
        detail.setPurchaseDT("20250711");                  // 거래일자
        detail.setItemName("품명");                         // 품명
        detail.setSpec("규격");                             // 규격
        detail.setQty("1");                                // 수량
        detail.setUnit("200000");                          // 단가
        detail.setSupplyCost("200000");                    // 공급가액
        detail.setTax("20000");                            // 세액
        detail.setRemark("비고1");                          // 비고

        statement.getDetailList().add(detail);

        detail = new StatementDetail();                    // 상세항목(품목) 배열
        detail.setSerialNum((short) 2);                    // 일련번호 1부터 순차기재
        detail.setPurchaseDT("20250711");                  // 거래일자
        detail.setItemName("품명");                         // 품명
        detail.setSpec("규격");                             // 규격
        detail.setQty("1");                                // 수량
        detail.setUnit("200000");                          // 단가
        detail.setSupplyCost("200000");                    // 공급가액
        detail.setTax("20000");                            // 세액
        detail.setRemark("비고1");                          // 비고

        statement.getDetailList().add(detail);

        // 전자명세서 상태 이력을 관리하기 위한 메모
        String Memo = "전자명세서 즉시발행 메모";

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

        // 발행 안내 메일 제목
        // - 미입력 시 팝빌에서 지정한  메일 제목으로 전송
        String emailSubject = "";

        try {

            SMTIssueResponse response = statementService.registIssue(CorpNum, statement, 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 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>
    <ul>
      <li>code (응답코드) : <span th:text="${Response.code}"></span></li>
      <li>message (응답메시지) : <span th:text="${Response.message}"></span></li>
      <li>invoiceNum (팝빌 승인번호) : <span th:text="${Response.invoiceNum}"></span></li>
    </ul>
  </body>
</html>

4. API 응답결과 확인

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

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