튜토리얼

Python 개발환경에서 팝빌 SDK를 추가하여 계좌 거래내역 수집요청 (RequestJob) 함수를 구현하는 예시입니다.

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

#생략
#...
#...

# 링크아이디
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 = True

3. RequestJob 기능 구현

Django App에 생성된 views.py 파일에 계좌조회 서비스 클래스 객체 생성과 계좌 거래내역 수집요청 (RequestJob) 함수 호출 코드를 추가합니다.

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

from config import settings

# settings.py 작성한 LinkID, SecretKey를 이용해 EasyFinBankService 서비스 객체 생성
easyFinBankService = EasyFinBankService(settings.LinkID, settings.SecretKey)

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

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

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

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

def requestJob(request):
    """
    계좌 거래내역 수집을 요청합니다.
    - 검색기간은 현재일 기준 90일 이내로만 요청할 수 있습니다.
    - 수집 요청후 반환받은 작업아이디(JobID)의 유효시간은 1시간 입니다.
    """
    try:
        # 팝빌회원 사업자번호
        CorpNum = "1234567890"

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

        # 기관코드
        BankCode = "0048"

        # 계좌번호
        AccountNumber = "3011599770921"

        # 시작일자, 날짜형식(yyyyMMdd)
        SDate = "20220101"

        # 종료일자, 날짜형식(yyyyMMdd)
        EDate = "20220101"

        result = easyFinBankService.requestJob(CorpNum, BankCode, AccountNumber,SDate, EDate, UserID)
        return render(request, 'response.html', {'result': result})
    except PopbillException as PE:
        return render(request, 'response.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>
    <fieldset class="fieldset1">
        <legend>수집 요청</legend>
        <ul>
            {% if code is None %}
            <li> 작업아이디(JobID) : {{ result }} </li>
            {% else %}
            <li> 오류 코드(code) : {{ code }} </li>
            <li> 오류 메시지(message) : {{ message }} </li>
            {% endif %}
        </ul>
    </fieldset>
</div>
</body>
</html>

4. 결과 확인

함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 로 숫자 1 반환
- 실패 : PopbillException 으로 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]