콘텐츠로 이동

튜토리얼 - JSP

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

1. POPBiLL SDK 추가

섹션 제목: “1. POPBiLL SDK 추가”

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

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

jar 파일설명
/usr/local/tomcat7/webapps/ROOT/WEB-INF/lib/gson-version.jarjavaObject <-> JSON 변환 구글 라이브러리
/usr/local/tomcat7/webapps/ROOT/WEB-INF/lib/linkhub-auth-version.jar링크허브 인증 라이브러리
/usr/local/tomcat7/webapps/ROOT/WEB-INF/lib/popbill-sdk-version.jar팝빌 API 및 통신 기능 라이브러리

2. POPBiLL SDK 설정

섹션 제목: “2. POPBiLL SDK 설정”

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

<%-- 팩스 서비스 객체 초기화 --%>
<jsp:useBean id="faxService" scope="application" class="com.popbill.api.fax.FaxServiceImp"/>


<%--
  API Key
  - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
  • LinkID: 파트너를 식별하기 위한 고유 식별자
  • SecretKey: API 인증토큰 발급에 사용되는 키


  TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
--%>
<jsp:setProperty name="faxService" property="linkID" value="TESTER"/>
<jsp:setProperty name="faxService" property="secretKey" value="SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="/>


<%--
  연동환경(테스트/운영) 설정
  - 연동환경을 테스트 또는 운영으로 설정합니다.
  • true: 테스트 환경으로 설정
  • false(default) : 운영 환경으로 설정


  ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다.
--%>
<jsp:setProperty name="faxService" property="test" value="true"/>


<%--
  인증토큰 IP 일치 검증 사용 여부
  - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
    (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
  • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
  • false(미사용) : IP 일치 검사를 생략


  ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
    예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
--%>
<jsp:setProperty name="faxService" property="IPRestrictOnOff" value="true"/>


<%--
  통신 IP 고정 여부
  - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
  • true(사용) : 고정(Static) IP 사용
  • false(미사용, default) : 가변(Elastic) IP 사용


  ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
    (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
--%>
<jsp:setProperty name="faxService" property="useStaticIP" value="false"/>


<%--
  로컬시스템 시간 사용 여부
  - 현재시각 기준을 설정합니다.
  • true(사용, default) : 로컬시스템 시간 사용
  • false(미사용) : 팝빌 서버의 시간을 사용


  ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
  ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
  ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
    서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.
--%>
<jsp:setProperty name="faxService" property="useLocalTimeYN" value="true"/>

3. SendFAX 기능 구현

섹션 제목: “3. 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" %>
<%


    // 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
    String CorpNum = "1234567890";


    // 발신번호
    // 팝빌에 등록되지 않은 번호를 입력하는 경우 '원발신번호'로 팩스 전송됨
    String sendNum = "07043042991";


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


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


    // 파일 목록
    // 파일 전송 개수 최대 30개
    File[] files = new File[2];
    files[0] = new File((application.getRealPath("/resources/test.jpg")));
    files[1] = new File((application.getRealPath("/resources/test.jpg")));


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


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


    // 광고팩스 전송여부 , true / false 중 택 1
    // └ true = 광고 , false = 일반
    // └ 미입력 시 기본값 false 처리
    Boolean adsYN = false;


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


    // 요청번호
    // 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
    // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
    String requestNum = "";


    String receiptNum = null;


    try {


        receiptNum = faxService.sendFAX(CorpNum, sendNum, receiveNum, receiveName,
                files, reserveDT, UserID, adsYN, title, requestNum);


    } catch (PopbillException pe) {
        // 예외 발생 시, pe.getCode() 로 오류코드를 확인하고, pe.getMessage()로 관련 오류메시지를 확인합니다.
        System.out.println("오류코드 " + pe.getCode());
        System.out.println("오류메세지 " + pe.getMessage());
    }
%>
    <body>
        <p>Response</p>
        <br/>
        <fieldset>
            <legend>팩스 전송 요청</legend>
            <ul>
                <li>receiptNum (접수번호) :<%=receiptNum%></li>
            </ul>
        </fieldset>
    </body>
</html>

4. API 응답결과 확인

섹션 제목: “4. API 응답결과 확인”

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

구분응답
성공ReceiptNum(접수번호) : 18자리 문자열
실패code : 오류코드 (8자리 음의 정수) [오류코드]
message : 오류메시지