튜토리얼
Node.js 개발환경에서 팝빌 SDK를 추가하여 계좌 거래내역 수집요청 (RequestJob) 함수를 구현하는 예시입니다.
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.60.4"
}
}2. POPBiLL SDK 설정
프로젝트 routes 폴더 하위의 index.js 파일에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 계좌조회 서비스 객체를 생성 합니다.
// 생략..
var popbill = require('popbill');
popbill.config( {
// 링크아이디
LinkID :'TESTER',
// 비밀키
SecretKey : 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T=',
// 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
IsTest : true,
// 통신 IP 고정, true-사용, false-미사용, (기본값:true)
IPRestrictOnOff: true,
// 팝빌 API 서비스 고정 IP 사용여부, 기본값(false)
UseStaticIP: false,
// 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
UseLocalTimeYN: true,
defaultErrorHandler: function (Error) {
console.log('Error Occur : [' + Error.code + '] ' + Error.message);
}
});
// 계좌조회 서비스 객체 초기화
var easyFinBankService = popbill.EasyFinBankService();
// 생략..
3. RequestJob 기능 구현
index.js 파일에 계좌 거래내역 수집요청 (RequestJob) 함수 호출 코드를 추가합니다.
/*
* 팝빌에 등록된 계좌의 거래내역 수집을 요청합니다.
* - 검색기간은 현재일 기준 90일 이내로만 요청할 수 있습니다.
* - 수집 요청후 반환받은 작업아이디(JobID)의 유효시간은 1시간 입니다.
*/
app.get('/requestJob', function (req, res, next) {
// 팝빌회원 사업자번호, '-' 제외 10자리
var testCorpNum = '1234567890';
// 기관코드
var bankCode = '0048';
// 계좌번호
var accountNumber = '3011599770921';
// 시작일자, 날짜형식(yyyyMMdd)
var SDate = '20220101';
// 종료일자, 날짜형식(yyyyMMdd)
var EDate = '20220130';
easyFinBankService.requestJob(testCorpNum, bankCode, accountNumber, SDate, EDate,
function (jobID) {
res.render('response', {path: req.path, result: jobID})
}, function (Error) {
console.log('오류 코드 :' + Error.code);
console.log('오류 메시지 :' + Error.message);
});
});함수 호출결과 코드와 메시지를 출력하는 "/views/response.ejs" 파일을 추가합니다.
<!DOCTYPE html>
<html>
<head>
<title>Popbill Node.js Example</title>
</head>
<body>
<div>
<p>Response</p>
<br/>
<fieldset>
<legend><%= path %></legend>
<ul>
<li>JobID(작업아이디) : <%= result %></li>
</ul>
</fieldset>
</div>
</body>
</html>4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : JobID(작업아이디) 18자리 문자열 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]