콘텐츠로 이동

튜토리얼

Node.js 개발환경에서 팝빌 SDK를 추가하고, 기업정보조회 (CheckBizInfo) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

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

팝빌 Node.js SDK를 추가하기 위해 Express 프로젝트 “package.json” 파일에 팝빌 Node.js SDK 정보를 추가하고 npm install 또는 npm update를 진행합니다.

{
  "name": "Popbill TEST",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    "start": "node ./bin/www"
  },
  "dependencies": {
    "cookie-parser": "~1.4.3",
    "debug": "~2.6.9",
    "ejs": "~2.5.7",
    "express": "~4.16.0",
    "http-errors": "~1.6.2",
    "morgan": "~1.9.0",
    "popbill": "^1.64.2"
  }
}

2. POPBiLL SDK 설정

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

프로젝트 routes 폴더 하위의 index.js 파일에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 기업정보조회 서비스 객체를 생성 합니다.

// 생략..


var popbill = require('popbill');


popbill.config( {


  // API Key
  // - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
  // • LinkID: 파트너를 식별하기 위한 고유 식별자
  // • SecretKey: API 인증토큰 발급에 사용되는 키
  //
  // TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
  LinkID :'TESTER',
  SecretKey : 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T=',


  // 연동환경(테스트/운영) 설정
  // - 연동환경을 테스트 또는 운영으로 설정합니다.
  // • true: 테스트 환경으로 설정
  // • false(default) : 운영 환경으로 설정
  //
  // ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게  환경 전환(테스트<->운영)이 가능합니다.
  IsTest : true,


  // 인증토큰 IP 일치 검증 사용 여부
  // - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
  //   (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
  // • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
  // • false(미사용) : IP 일치 검사를 생략
  //
  // ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
  //   예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
  IPRestrictOnOff: true,


  // 통신 IP 고정 여부
  // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
  // • true(사용) : 고정(Static) IP 사용
  // • false(미사용, default) : 가변(Elastic) IP 사용
  //
  // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
  //   (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
  UseStaticIP: false,


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


  defaultErrorHandler: function (Error) {
    console.log('Error Occur : [' + Error.code + '] ' + Error.message);
  }


});


// 기업정보조회 서비스 객체 초기화
var bizInfoCheckService = popbill.BizInfoCheckService();


// 생략..

3. CheckBizInfo 기능 구현

섹션 제목: “3. CheckBizInfo 기능 구현”

index.js 파일에 기업정보조회 (CheckBizInfo) 함수 호출 코드를 추가합니다.

router.get('/checkBizInfo', function (req, res, next) {


    // 팝빌회원 사업자번호, '-' 제외 10자리
    var MemberCorpNum = '1234567890';


    // 조회할 사업자번호
    var checkCorpNum = '1234567890';


    bizinfocheckService.checkBizInfo(MemberCorpNum, checkCorpNum,
        function (CorpState) {
            res.render('CheckBizInfo', {path: req.path, result: BizCheckInfo});
        }, function (Error) {
            res.render('response', {path: req.path, code: Error.code, message: Error.message});
        });
});

함수 호출결과 코드와 메시지를 출력하는 “/views/CheckBizInfo.ejs” 파일을 추가합니다.

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <link rel="stylesheet" href="/stylesheets/style.css"/>
    <title>Popbill BizInfoCheck.</title>
</head>
<body>
<div>
    <br/>
    <fieldset>
    <legend>기업정보조회</legend>
    <ul>
      <% if (typeof result  != 'undefined') { %>
        <li>corpNum (사업자번호) : <%= result.corpNum%></li>
        <li>companyRegNum (법인번호): <%=result.companyRegNum%></li>
        <li>checkDT (확인일시) : <%=result.checkDT%></li>
        <li>corpName (상호): <%=result.corpName%></li>
        <li>corpCode (기업형태코드): <%=result.corpCode%></li>
        <li>corpScaleCode (기업규모코드): <%=result.corpScaleCode%></li>
        <li>personCorpCode (개인법인코드): <%=result.personCorpCode%></li>
        <li>headOfficeCode (본점지점코드) : <%=result.headOfficeCode%></li>
        <li>industryCode (산업코드) : <%=result.industryCode%></li>
        <li>establishCode (설립구분코드) : <%=result.establishCode%></li>
        <li>establishDate (설립일자) : <%=result.establishDate%></li>
        <li>CEOName (대표자명) : <%=result.ceoname%></li>
        <li>workPlaceCode (사업장구분코드): <%=result.workPlaceCode%></li>
        <li>addrCode (주소구분코드) : <%=result.addrCode%></li>
        <li>zipCode (우편번호) : <%=result.zipCode%></li>
        <li>addr (주소) : <%=result.addr%></li>
        <li>addrDetail (상세주소) : <%=result.addrDetail%></li>
        <li>enAddr (영문주소) : <%=result.enAddr%></li>
        <li>bizClass (업종) : <%=result.bizClass%></li>
        <li>bizType (업태) : <%=result.bizType%></li>
        <li>result (상태코드) : <%=result.result%></li>
        <li>resultMessage (상태메시지) : <%=result.resultMessage%></li>
        <li>closeDownTaxType (사업자과세유형) : <%=result.closeDownTaxType%></li>
        <li>closeDownTaxTypeDate (과세유형전환일자):<%=result.closeDownTaxTypeDate%></li>
        <li>closeDownState (휴폐업상태) : <%=result.closeDownState%></li>
        <li>closeDownStateDate (휴폐업일자) : <%=result.closeDownStateDate%></li>
      <% } else { %>
        <li>오류코드 : <%= code %></li>
        <li>오류메시지 : <%= message %></li>
      <% } %>
    </ul>
    </fieldset>
    <br/>
</div>
</body>
</html>

4. API 응답결과 확인

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

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

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