튜토리얼

Python 개발환경에서 팝빌 SDK를 추가하고, 현금영수증 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 Python SDK를 추가하기 위해 pip install 명령어를 사용하여 패키지를 설치합니다.

$ pip install popbill

2. 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

#생략
#...
#...

# 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

3. 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. API 응답결과 확인

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

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