콘텐츠로 이동

튜토리얼

Python 개발환경에서 팝빌 SDK를 추가하고, 팩스 전송 (SendFAX) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

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

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

$ pip install popbill

2. POPBiLL SDK 설정

섹션 제목: “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. SendFAX 기능 구현

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

Django App에 생성된 views.py 파일에 팩스 서비스 클래스 객체 생성과 팩스 전송 (SendFAX) 함수 호출 코드를 추가합니다.

# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import FaxService, PopbillException, ContactInfo, JoinForm, FaxReceiver, CorpInfo


from config import settings


# settings.py 작성한 LinkID, SecretKey를 이용해 FaxService 객체 생성
faxService = FaxService(settings.LinkID, settings.SecretKey)


# 연동환경 설정값, 개발용(True), 상업용(False)
faxService.IsTest = settings.IsTest


# 인증토큰 IP제한기능 사용여부, 권장(True)
faxService.IPRestrictOnOff = settings.IPRestrictOnOff


# 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
faxService.UseStaticIP = settings.UseStaticIP


# 로컬시스템 시간 사용여부, 권장(True)
faxService.UseLocalTimeYN = settings.UseLocalTimeYN


def sendFAX(request):
    try:
        # 팝빌회원 사업자번호
        CorpNum = "1234567890"


        # 팝빌회원 아이디
        UserID = "testkorea"


        # 발신번호
        Sender = "070111222"


        # 발신자명
        SenderName = "발신자명"


        # 수신번호
        Receiver = "070222111"


        # 수신자명
        ReceiverName = "수신자명"


        # 파일경로 (해당파일에 읽기 권한이 설정되어 있어야 함. 최대 30개)
        FilePath = ["./FaxExample/static/file/faxfile.jpg", "./FaxExample/static/file/test.pdf"]


        # 예약전송시간, 작성형식:yyyyMMddHHmmss, 공백 기재시 즉시전송
        ReserveDT = ""


        # 광고팩스 전송여부
        AdsYN = False


        # 팩스제목
        Title = "Python 팩스단건 제목"


        # 요청번호
        # 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
        # 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
        RequestNum = ""


        receiptNum = faxService.sendFax(CorpNum, Sender, Receiver, ReceiverName,
                                        FilePath, ReserveDT, UserID, SenderName, AdsYN, Title, RequestNum)


        return render(request, 'response.html', {'receiptNum': receiptNum})
    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">
        <fieldset class="fieldset1">
            <legend>팩스 접수번호</legend>
            <ul>
                <li> receiptNum (접수번호) : {{ receiptNum }} </li>
            </ul>
        </fieldset>
    </div>
  </body>
</html>

4. API 응답결과 확인

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

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

구분응답
성공ReceiptNum(접수번호) : 18자리 문자열
실패code : 오류코드 (8자리 음의 정수) [오류코드]
message : 오류메시지