# 튜토리얼
Node.js 개발환경에서 팝빌 SDK를 추가하고, 전자명세서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
## 1. POPBiLL SDK 추가
팝빌 Node.js SDK를 추가하기 위해 Express 프로젝트 “package.json” 파일에 팝빌 Node.js SDK 정보를 추가하고 npm install 또는 npm update를 진행합니다.
```json
{
"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 설정
프로젝트 routes 폴더 하위의 index.js 파일에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 전자명세서 서비스 객체를 생성 합니다.
```javascript
// 생략..
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 statementService = popbill.StatementService();
// 생략..
```
## 3. RegistIssue 기능 구현
index.js 파일에 전자명세서 즉시 발행 (RegistIssue) 함수 호출 코드를 추가합니다.
```javascript
router.get('/registIssue', function (req, res, next) {
// 팝빌회원 사업자번호, '-' 제외 10자리
var testCorpNum = '1234567890';
// 명세서 코드 - 121(거래명세서), 122(청구서), 123(견적서), 124(발주서), 125(입금표), 126(영수증)
var ItemCode = 121;
// 문서번호, 1~24자리 영문, 숫자, '-', '_' 조합으로 구성, 사업자별로 중복되지 않도록 생성
var MgtKey = '20250314-001';
// 전자명세서 정보
var statement = {
// [필수] 기재상 작성일자, 날짜형식(yyyyMMdd)
writeDate: '20250314',
// [필수] 영수, 청구, 없음 중 기재
purposeType: '영수',
// [필수] 과세형태, 과세, 영세, 면세 중 기재
taxType: '과세',
// 맞춤양식코드, 미기재시 기본양식으로 작성
formCode: '',
// [필수] 명세서 코드
itemCode: ItemCode,
// [필수] 문서번호
mgtKey: MgtKey,
/*************************************************************************
* 발신자 정보
**************************************************************************/
// 발신자 사업자번호
senderCorpNum: testCorpNum,
// 발신자 상호
senderCorpName: '발신자 상호',
// 발신자 주소
senderAddr: '발신자 주소',
// 발신자 대표자 성명
senderCEOName: '발신자 대표자 성명',
// 종사업장 식별번호, 필요시기재, 형식은 숫자 4자리
senderTaxRegID: '',
// 발신자 종목
senderBizClass: '종목',
// 발신자 업태
senderBizType: '업태',
// 발신자 담당자명
senderContactName: '담당자명',
// 발신자 메일주소
senderEmail: 'test@test.com',
// 발신자 연락처
senderTEL: '070-4304-2991',
// 발신자 휴대폰번호
senderHP: '000-111-222',
/*************************************************************************
* 수신자 정보
**************************************************************************/
// 수신자 사업자번호
receiverCorpNum: '8888888888',
// 수신자 상호
receiverCorpName: '수신자상호',
// 수신자 대표자 성명
receiverCEOName: '수신자 대표자 성명',
// 수신자 주소
receiverAddr: '수신자 주소',
// 수신자 종사업장 식별번호, 필요시 기재
recieverTaxRegID: '',
// 수신자 종목
receiverBizClass: '종목',
// 수신자 업태
receiverBizType: '업태',
// 수신자 담당자명
receiverContactName: '수신자 담당자 성명',
// 수신자 메일주소
// 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
// 실제 거래처의 메일주소가 기재되지 않도록 주의
receiverEmail: 'test@test.com',
// 수신자 연락처
receiverTEL: '070-1111-2222',
// 수신자 휴대폰 번호
receiverHP: '000111222',
/*************************************************************************
* 전자명세서 기재정보
**************************************************************************/
// [필수] 공급가액 합계
supplyCostTotal: '20000',
// [필수] 세액 합계
taxTotal: '2000',
// [필수] 합계금액 (공급가액 합계+ 세액 합계)
totalAmount: '22000',
// 기재 상 '일련번호' 항목
serialNum: '1',
// 기재 상 '비고' 항목
remark1: '비고1',
remark2: '비고2',
remark3: '비고3',
// 사업자등록증 이미지 첨부 여부
businessLicenseYN: false,
// 통장사본 이미지 첨부 여부
bankBookYN: false,
/*************************************************************************
* 상세9항목(품목) 정보
**************************************************************************/
detailList: [
{
serialNum: 1, // 품목 일련번호 1부터 순차기재
itemName: '품명',
purchaseDT: '20250314', // 구매일자
qty: '1', // 수량
unitCost: '10000', // 단가
spec: '규격', // 규격
supplyCost: '10000', // 공급가액
tax: '1000', // 세액
remark: '비고'
},
{
serialNum: 2, // 품목 일련번호 1부터 순차기재
itemName: '품명2',
purchaseDT: '20250314', // 구매일자
qty: '1', // 수량
unitCost: '10000', // 단가
spec: '규격', // 규격
supplyCost: '10000', // 공급가액
tax: '1000', // 세액
remark: '비고'
}
],
/*************************************************************************
* 전자명세서 추가속성
**************************************************************************/
propertyBag: {
Balance: '2000', // 전잔액
Deposit: '500', // 입금액
CBalance: '2500' // 현잔액
}
};
statementService.registIssue(testCorpNum, statement,
function (result) {
res.render('response', {path: req.path, code: result.code, message: result.message});
}, function (Error) {
res.render('response', {path: req.path, code: Error.code, message: Error.message});
});
});
```
함수 호출결과 코드와 메시지를 출력하는 “/views/response.ejs” 파일을 추가합니다.
```javascript
Popbill Statement
Response
```
## 4. API 응답결과 확인
API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
| -- | --------------------------------------------------------------------------------------------- |
| 성공 | code : 1 |
| 실패 | code : 오류코드 (8자리 음의 정수) [\[오류코드\]](https://developers.popbill.com/error-code) message : 오류메시지 |