팝빌 팩스 SDK 튜토리얼

SpringMVC/SpirngBoot/JSP 개발환경에서 팝빌 Java SDK를 추가하여 팩스 전송(SendFAX) SDK 함수를 구현하는 예시입니다.

  • SpringMVC
  • SpringBoot
  • JSP

1. Maven을 이용한 Popbill SDK 추가 팝빌 Java SDK SpringMVC Example

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

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

② 팩스 클래스를 Spring 빈으로 추가합니다. 아래의 코드를 참조하여 "servlet-context.xml" 파일을 수정합니다.

연동신청시 발급받은 인증정보로 링크아이디(LinkID)와 비밀키(SecretKey) property 값을 변경하시기 바랍니다.

<?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">

    <!-- DispatcherServlet Context: defines this servlet's request-processing infrastructure -->
    <!-- Enables the Spring MVC @Controller programming model -->
    <annotation-driven/>

    <!-- Handles HTTP GET requests for /resources/** by efficiently serving up static resources in the ${webappRoot}/resources directory -->
    <resources mapping="/resources/**" location="/resources/"/>

    <!-- Resolves views selected for rendering by @Controllers to .jsp resources in the /WEB-INF/views directory -->
    <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">
        <!-- 링크아이디 -->
        <beans:prop key="LinkID">TESTER</beans:prop>
        <!-- 비밀키 -->
        <beans:prop key="SecretKey">SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=</beans:prop>
        <!-- 연동환경 설정값 true(개발용), false(상업용) -->
        <beans:prop key="IsTest">true</beans:prop>
        <!-- 인증토큰 아이피 제한 기능 사용여부 권장(true) -->
        <beans:prop key="IsIPRestrictOnOff">true</beans:prop>
        <!-- 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false) -->
        <beans:prop key="UseStaticIP">false</beans:prop>
        <!-- 로컬시스템 시간 사용여부 true-사용(기본값-권장), false-미사용 -->
        <beans:prop key="UseLocalTimeYN">true</beans:prop>
    </util:properties>

    <beans:beans>
        <!-- 팩스 Service Implementation Bean registration.  -->
        <beans:bean id="faxService" class="com.popbill.api.fax.FaxServiceImp">
    
            <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>

2. 팩스 전송(SendFAX) 기능 구현

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

import java.io.File;
import java.net.URISyntaxException;
import java.util.Date;

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.FaxService;
import com.popbill.api.PopbillException;

@Controller
public class FaxServiceExample {

    @Autowired
    private FaxService faxService;

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

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

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

        // 발신번호
        String sendNum = "07043042995";

        // 수신번호
        String receiveNum = "070111222";

        // 수신자명
        String receiveName = "수신자 명칭";

        // 파일객체 배열, 호출당 최대 20개 파일 전송 가능
        File[] files = new File[2];

        try {
            files[0] = new File(getClass().getClassLoader().getResource("nonbg_statement.pdf").toURI());
            files[1] = new File(getClass().getClassLoader().getResource("nonbg_statement.pdf").toURI());
        } catch (URISyntaxException e1) {
            throw e1;
        }

        // 전송 예약일시
        Date reserveDT = null;

        // 광고팩스 전송여부
        Boolean adsYN = false;

        // 팩스제목
        String title = "팩스 제목";

        // 전송요청번호
        // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
        // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
        String requestNum = "";

        try {

            String receiptNum = faxService.sendFAX(corpNum, sendNum, receiveNum,
                    receiveName, files, reserveDT, userID, adsYN, title, requestNum);

            m.addAttribute("Result", receiptNum);

        } catch (PopbillException e) {
            // 예외 발생 시, e.getCode() 로 오류 코드를 확인하고, e.getMessage()로 오류 메시지를 확인합니다.
            System.out.println("오류 코드" + e.getCode());
            System.out.println("오류 메시지" + e.getMessage());
        }

        return "response";
    }
}

② 함수 호출결과 코드와 메시지를 매핑하는 "src/main/webapp/WEB-INF/views/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>접수번호(ReceiptNum) : ${Result}</p>
  </body>
</html>

③ 웹브라우저 페이지를 호출하여 함수호출 결과로 반환되는 접수번호(ReceiptNum)를 확인합니다.

팝빌 Java SDK SpringMVC 팩스 Example

1. Popbill SDK 추가 팝빌 Java SDK JSP Example

① 팝빌 연동자료실에서 Java - JSP SDK 예제코드 다운로드 후 압축을 해제합니다.

② SDK 예제코드의 WEB-INF/lib/ 폴더의 3개 jar파일 구현할 프로젝트의 라이브러리 폴더에 복사합니다.

팝빌 Java SDK jar 파일

③ 프로젝트 경로에 팩스 서비스 연동환경 설정을 위한 "$CATALINA_HOME/webapps/ROOT/common.jsp" 파일을 생성하고 아래의 코드를 참고하여 인증정보를 설정합니다.

연동신청시 발급받은 인증정보로 링크아이디(LinkID)와 비밀키(SecretKey) 값을 변경하시기 바랍니다.

<%-- 팩스 클래스 빈 생성 --%>
<jsp:useBean id="faxService" scope="application" class="com.popbill.api.fax.FaxServiceImp" />

<%-- 링크아이디 --%>
<jsp:setProperty name="faxService" property="linkID" value="TESTER" />

<%-- 비밀키, 사용자 인증에 사용되는 정보이므로 유출에 주의 --%>
<jsp:setProperty name="faxService" property="secretKey" value="SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=" />

<%-- 연동환경 설정값, 개발용(true), 상업용(false) --%>
<jsp:setProperty name="faxService" property="test" value="true" />

<%-- 인증토큰 발급 IP 제한 On/Off, ture -제한기능 사용(기본값-권장), false-제한기능 미사용 --%>
<jsp:setProperty name="faxService" property="IPRestrictOnOff" value="true" />

<%-- 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false) --%>
<jsp:setProperty name="faxService" property="useStaticIP" value="false"/>

<%-- 로컬시스템 시간 사용여부 true-사용(기본값-권장), false-미사용 --%<
<jsp:setProperty name="faxService" property="useLocalTimeYN" value="true"/>

2. 팩스 전송(SendFAX) 함수 구현

① "$CATALINA_HOME/webapps/ROOT/sendFAX.jsp" 파일을 생성하고, 아래의 코드를 참조하여 함수 호출 코드를 추가합니다.

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <title>Popbill FAX Example</title>
    </head>
<%@ include file="common.jsp" %>
<%@page import="java.io.File" %>
<%@page import="java.util.Date" %>
<%@page import="java.text.SimpleDateFormat" %>
<%@page import="com.popbill.api.PopbillException" %>
<%

    /*
     * 팩스를 전송합니다. (전송할 파일 개수는 최대 20개까지 가능)
     */

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

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

    // 발신번호
    String sendNum = "07043042991";

    // 발신자명
    String senderName = "발신자명";

    // 수신자명
    String receiveName = "수신자명";

    // 수신 팩스번호
    String receiveNum = "070111222";

    // 예약전송일시(yyyyMMddHHmmss), null인 경우 즉시전송
    Date reserveDT = null;

    // String reserveDTtxt = "20220126120000";
    // SimpleDateFormat formatter = new SimpleDateFormat("yyyyMMddHHmmss");
    // reserveDT = formatter.parse(reserveDTtxt);
    // 팩스전송파일 경로
    // 파일 전송 개수 최대 20개
    File[] files = new File[2];
    files[0] = new File((application.getRealPath("/resources/test.jpg")));
    files[1] = new File("C:/Users/jhlee/Desktop/test.txt");

    // 광고팩스 전송여부
    Boolean adsYN = false;

    // 팩스제목
    String title = "팩스제목";

    // 전송요청번호
    // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
    // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
    String requestNum = "";

    String receiptNum = null;
    try {
        receiptNum = faxService.sendFAX(testCorpNum, sendNum, receiveNum, receiveName,
                files, reserveDT, testUserID, adsYN, title, requestNum);
    } catch (PopbillException pe) {
        //적절한 오류 처리를 합니다. pe.getCode() 로 오류코드를 확인하고, pe.getMessage()로 관련 오류메시지를 확인합니다.
        System.out.println("오류코드 " + pe.getCode());
        System.out.println("오류메시지 " + pe.getMessage());
        throw pe;
    }
%>
    <body>
        <p>Response</p>
        <br/>
        <fieldset>
            <legend>팩스 전송 요청</legend>
            <ul>
                <li>receiptNum (접수번호) :<%=receiptNum%></li>
            </ul>
        </fieldset>
    </body>
</html>

② 웹브라우저 페이지를 호출하여 함수호출 결과를 확인합니다.

팝빌 Java JSP SDK 팩스 Example

1. Gradle을 이용한 Popbill SpringBoot Starter 추가 팝빌 Java SDK SpringBoot Example

① 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.5.0'
}

② SDK 설정을 위해 아래의 코드를 appllication.yml 파일에 추가합니다.

연동신청시 발급받은 인증정보로 링크아이디(LinkID)와 비밀키(SecretKey) property 값을 변경하시기 바랍니다.

popbill:
  #링크아이디
  linkId: TESTER
  #비밀키
  secretKey: SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=
  #연동환경 설정값 true(개발용), false(상업용)
  isTest: true
  #인증토큰 아이피 제한 기능 사용여부 true(사용-권장), false(미사용)
  isIpRestrictOnOff: true
  #팝빌 API 서비스 고정 IP 사용여부 true(사용), false(미사용)
  useStaticIp: false
  #로컬시스템 시간 사용여부 true(사용-권장), false(미사용)
  useLocalTimeYn: true

2. 팩스 전송(SendFAX) 기능 구현

① @Autowired 어노테이션을 이용하여 생성된 서비스 클래스 빈 객체를 주입 받은 후 sendFAX 함수 코드를 추가합니다.

import java.io.File;
import java.net.URISyntaxException;
import java.util.Date;

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.FaxService;
import com.popbill.api.PopbillException;

@Controller
public class FaxServiceController {

    @Autowired
    private FaxService faxService;

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

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

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

        // 발신번호
        String sendNum = "07043042995";

        // 수신번호
        String receiveNum = "070111222";

        // 수신자명
        String receiveName = "수신자 명칭";

        // 파일객체 배열, 호출당 최대 20개 파일 전송 가능
        File[] files = new File[2];

        try {
            files[0] = new File(getClass().getClassLoader().getResource("nonbg_statement.pdf").toURI());
            files[1] = new File(getClass().getClassLoader().getResource("nonbg_statement.pdf").toURI());
        } catch (URISyntaxException e1) {
            throw e1;
        }

        // 전송 예약일시
        Date reserveDT = null;

        // 광고팩스 전송여부
        Boolean adsYN = false;

        // 팩스제목
        String title = "팩스 제목";

        // 전송요청번호
        // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
        // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
        String requestNum = "";

        try {

            String receiptNum = faxService.sendFAX(corpNum, sendNum, receiveNum,
            receiveName, files, reserveDT, userID, adsYN, title, requestNum);

            m.addAttribute("Result", receiptNum);

        } catch (PopbillException e) {
            // 예외 발생 시, e.getCode() 로 오류 코드를 확인하고, e.getMessage()로 오류 메시지를 확인합니다.
            System.out.println("오류 코드" + e.getCode());
            System.out.println("오류 메시지" + e.getMessage());
        }

        return "response";
    }
}

② 함수 호출결과 코드와 메시지를 매핑하는 "src/main/resources/templates/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>접수번호(ReceiptNum) : <span th:text="${Result}"></span></li>
    </ul>
  </body>
</html>

③ 웹브라우저 페이지를 호출하여 함수호출 결과로 반환되는 접수번호(ReceiptNum)를 확인합니다.

팝빌 Java SDK SpringBoot 팩스 Example

기술지원센터

팝빌 기술지원은 유선, 메일, 원격지원 등 다양한 채널을 통해 제공됩니다.

T. 1600-9854   E. code@linkhubcorp.com

연동문의