튜토리얼
Python 개발환경에서 팝빌 SDK를 추가하여 현금영수증 즉시 발행 (RegistIssue) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가
팝빌 Python SDK를 추가하기 위해 pip install 명령어를 사용하여 패키지를 설치합니다.
$ pip install popbill2. POPBiLL SDK 설정
Django 프로젝트의 settings.py 파일에 연동신청시 발급받은 API Key 와 연동환경 설정값을 선언합니다.
# -*- coding: utf-8 -*-
import os
import sys
import imp
imp.reload(sys)
try:
sys.setdefaultencoding('UTF8')
except Exception as E:
pass
#생략
#...
#...
# 링크아이디
LinkID = "TESTER"
# 비밀키
SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T="
# 연동환경 설정, True-테스트, False-운영(Production), (기본값:False)
IsTest = True
# 인증토큰 IP 검증 설정, True-사용, False-미사용, (기본값:True)
IPRestrictOnOff = True
# 통신 IP 고정, True-사용, False-미사용, (기본값:False)
UseStaticIP = False
# 로컬시스템 시간 사용여부, True-사용, False-미사용, (기본값:True)
UseLocalTimeYN = True3. RegistIssue 기능 구현
Django App에 생성된 views.py 파일에 현금영수증 서비스 클래스 객체 생성과 현금영수증 즉시 발행 (RegistIssue) 함수 호출 코드를 추가합니다.
# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import CashbillService, PopbillException, Cashbill, ContactInfo, CorpInfo, JoinForm
from config import settings
# settings.py 작성한 LinkID, SecretKey를 이용해 CashbillService 객체 생성
cashbillService = CashbillService(settings.LinkID, settings.SecretKey)
# 연동환경 설정값, 개발용(True), 상업용(False)
cashbillService.IsTest = settings.IsTest
# 인증토큰 IP제한기능 사용여부, 권장(True)
cashbillService.IPRestrictOnOff = settings.IPRestrictOnOff
# 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
cashbillService.UseStaticIP = settings.UseStaticIP
#로컬시스템 시간 사용여부, 권장(True)
cashbillService.UseLocalTimeYN = settings.UseLocalTimeYN
def registIssue(request):
try:
# 팝빌회원 사업자번호
CorpNum = "1234567890"
# 팝빌회원 아이디
UserID = "testkorea"
# 현금영수증 상태 이력을 관리하기 위한 메모
Memo = "현금영수증 즉시 발행 메모"
# 현금영수증 객체 생성
cashbill = Cashbill(
# 문서번호
# 문서 관리를 위해 파트너가 할당하는 식별번호
# 1~24자리 영문 대소문자, 숫자, 특수문자('-','_')로 구성
mgtKey="20250314-001",
# 거래일시, 형식(yyyyMMddHHmmss)
# 발행기준 전일부터 당일까지 입력 가능
# 미입력시 기본값(발행일시) 처리됨
tradeDT="20250319093919",
# 문서형태
tradeType="승인거래",
# 과세형태, [과세, 비과세] 중 기재
taxationType="과세",
# 거래유형, [일반, 도서공연, 대중교통] 중 기재
tradeOpt="일반",
# 거래구분, [소득공제용, 지출증빙용] 중 기재
tradeUsage="소득공제용",
# 공급가액
supplyCost="10000",
# 부가세
tax="1000",
# 봉사료
serviceFee="0",
# 합계금액, 공급가액 + 부가세 + 봉사료
totalAmount="11000",
# 가맹점 사업자번호, "-" 제외 10자리
franchiseCorpNum=CorpNum,
# 가맹점 종사업장 식별번호
franchiseTaxRegID="",
# 가맹점 상호
franchiseCorpName="발행자 상호",
# 가맹점 대표자성명
franchiseCEOName="발행 대표자 성명",
# 가맹점 주소
franchiseAddr="발행자 주소",
# 가맹점 전화번호
franchiseTEL="07012345678",
# 식별번호, 거래구분에 따라 작성
# 소득공제용 - 주민등록/휴대폰/카드번호/자진발급용 번호(010-000-1234) 기재가능
# 지출증빙용 - 사업자번호/주민등록/휴대폰/카드번호 기재가능
identityNum="010-000-1234",
# 주문 상품명
itemName="주문상품명",
# 주문번호
orderNumber="주문번호",
# 구매자(고객) 성명
customerName="구매자명",
# 구매자(고객) 이메일
# 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로,
# 실제 구매자의 메일주소가 기재되지 않도록 주의
email="test@test.com",
# 구매자(고객) 휴대폰
hp="010111222",
# 구매자 알림문자 전송 여부
# 알림문자 전송시 포인트가 차감되며, 전송실패시 환불처리됨
smssendYN=False
)
response = cashbillService.registIssue(CorpNum, cashbill, Memo, UserID)
return render(request, 'response.html', {'code': response.code, 'message': response.message})
except PopbillException as PE:
return render(request, 'exception.html', {'code': PE.code, 'message': PE.message})
함수 호출결과 코드와 메시지를 출력하는 "/response.html" 파일을 추가합니다.
<html xmlns=" http://www.w3.org/1999/xhtml ">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Popbill API Test.</title>
</head>
<body>
<div id="content">
<p class="heading1">Response</p>
<br/>
<fieldset class="fieldset1">
<ul>
<li>응답코드 (Response.code) : {{ code }}</li>
<li>응답메시지 (Response.message) : {{ message }}</li>
</ul>
</fieldset>
</div>
</body>
</html>4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 숫자 1 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]