튜토리얼 - JSP
Java 개발환경에서 팝빌 SDK를 추가하고, 기업정보조회 (CheckBizInfo) 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.jar | javaObject <-> 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="bizInfoCheckService" scope="application" class="com.popbill.api.bizInfoCheck.BizInfoCheckServiceImp"/>
<%-- API Key - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성) • LinkID: 파트너를 식별하기 위한 고유 식별자 • SecretKey: API 인증토큰 발급에 사용되는 키
TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.--%><jsp:setProperty name="bizInfoCheckService" property="linkID" value="TESTER"/><jsp:setProperty name="bizInfoCheckService" property="secretKey" value="SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="/>
<%-- 연동환경(테스트/운영) 설정 - 연동환경을 테스트 또는 운영으로 설정합니다. • true: 테스트 환경으로 설정 • false(default) : 운영 환경으로 설정
※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다.--%><jsp:setProperty name="bizInfoCheckService" property="test" value="true"/>
<%-- 인증토큰 IP 일치 검증 사용 여부 - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다. (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치) • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용 • false(미사용) : IP 일치 검사를 생략
※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경--%><jsp:setProperty name="bizInfoCheckService" property="IPRestrictOnOff" value="true"/>
<%-- 통신 IP 고정 여부 - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다. • true(사용) : 고정(Static) IP 사용 • false(미사용, default) : 가변(Elastic) IP 사용
※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다. (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)--%><jsp:setProperty name="bizInfoCheckService" property="useStaticIP" value="false"/>
<%-- 로컬시스템 시간 사용 여부 - 현재시각 기준을 설정합니다. • true(사용, default) : 로컬시스템 시간 사용 • false(미사용) : 팝빌 서버의 시간을 사용
※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다. ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다. ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.--%><jsp:setProperty name="bizInfoCheckService" property="useLocalTimeYN" value="true"/>3. CheckBizInfo 기능 구현
섹션 제목: “3. CheckBizInfo 기능 구현”“$CATALINA_HOME/webapps/ROOT/CheckBizInfo.jsp” 파일을 생성하고, 아래의 코드를 참조하여 함수 호출 코드를 추가합니다.
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%><!DOCTYPE html><html> <head> <meta charset="UTF-8" /> <title>Popbill BizInfoCheck Example</title> </head><%@ include file="common.jsp" %><%@page import="com.popbill.api.BizCheckInfo"%><%@page import="com.popbill.api.PopbillException"%><%
BizCheckInfo bizInfo = null;
// 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리) String CorpNum = "1234567890";
// 조회할 사업자번호 String CheckCorpNum = "6798700433";
// 팝빌회원 아이디 String UserID = "testkorea";
try { bizInfo = bizInfoCheckService.CheckBizInfo(CorpNum, CheckCorpNum, UserID); } catch (PopbillException pe) { // 예외 발생 시, pe.getCode() 로 오류코드를 확인하고, pe.getMessage()로 관련 오류메시지를 확인합니다. System.out.println("오류코드 " + pe.getCode()); System.out.println("오류메세지 " + pe.getMessage()); }%> <body> <fieldset> <legend>기업정보조회</legend> <% if (null != bizCheckInfo) { %> <ul> <li>corpNum (사업자번호) : <%=bizInfo.getCorpNum()%></li> <li>companyRegNum (법인등록번호): <%=bizInfo.getCompanyRegNum()%></li> <li>checkDT (기업정보조회일시) : <%=bizInfo.getCheckDT()%></li> <li>corpName (상호): <%=bizInfo.getCorpName()%></li> <li>CEOName (대표자명) : <%=bizInfo.getCEOName()%></li> <li>corpCode (기업형태코드): <%=bizInfo.getCorpCode()%></li> <li>corpScaleCode (기업규모코드): <%=bizInfo.getCorpScaleCode()%></li> <li>personCorpCode (개인/법인코드): <%=bizInfo.getPersonCorpCode()%></li> <li>headOfficeCode (본점/지점코드) : <%=bizInfo.getHeadOfficeCode()%></li> <li>industryCode (산업코드) : <%=bizInfo.getIndustryCode()%></li> <li>establishDate (설립일자) : <%=bizInfo.getEstablishDate()%></li> <li>establishCode (설립코드) : <%=bizInfo.getEstablishCode()%></li> <li>workPlaceCode (사업장코드): <%=bizInfo.getWorkPlaceCode()%></li> <li>addrCode (주소코드) : <%=bizInfo.getAddrCode()%></li> <li>zipCode (우편번호) : <%=bizInfo.getZipCode()%></li> <li>addr (주소) : <%=bizInfo.getAddr()%></li> <li>addrDetail (상세주소) : <%=bizInfo.getAddrDetail()%></li> <li>enAddr (영문주소) : <%=bizInfo.getEnAddr()%></li> <li>bizClass (업종) : <%=bizInfo.getBizClass()%></li> <li>bizType (업태) : <%=bizInfo.getBizType()%></li> <li>result (상태코드) : <%=bizInfo.getResult()%></li> <li>resultMessage (상태메시지) : <%=bizInfo.getResultMessage()%></li> <li>closeDownState (휴폐업상태) : <%=bizInfo.getCloseDownState()%></li> <li>closeDownStateDate (휴폐업일자) : <%=bizInfo.getCloseDownStateDate()%></li> <li>closeDownTaxType (과세유형) : <%=bizInfo.getCloseDownTaxType()%></li> <li>closeDownTaxTypeDate (과세유형 전환일자):<%=bizInfo.getCloseDownTaxTypeDate()%></li> </ul> <% } else { %> <ul> <li> 오류코드와 메시지를 확인하세요</li> </ul> <% } %> </fieldset> <br> </body></html>4. API 응답결과 확인
섹션 제목: “4. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | result(상태코드) : 100 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |