튜토리얼

Python 개발환경에서 팝빌 SDK를 추가하여 기업정보조회 (BizInfoCheck) 함수를 구현하는 예시입니다.

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. BizInfoCheck 기능 구현

Django App에 생성된 views.py 파일에 기업정보조회 서비스 클래스 객체 생성과 기업정보조회 (BizInfoCheck) 함수 호출 코드를 추가합니다.

# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import BizInfoCheckService, PopbillException

from config import settings

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

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

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

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

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

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

        # 조회할 사업자번호
        CheckCorpNum = "6798700433";

        bizCheckInfo = bizInfoCheckService.checkBizinfo(MemberCorpNum, CheckCorpNum)

        return render(request, 'response.html', {'bizCheckInfo': bizCheckInfo})
    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>
<div id="content">
    <fieldset class="fieldset1">
        <br>
        <legend>기업정보조회</legend>
        <ul>
          {% if code is None %}
          <li> corpNum (사업자번호) : {{bizCheckInfo.corpNum}}</li>
          <li> companyRegNum (법인번호) :   {{bizCheckInfo.companyRegNum}}</li>
          <li> checkDT (확인일시) : {{bizCheckInfo.checkDT}}</li>
          <li> corpName (상호) : {{bizCheckInfo.corpName}}</li>
          <li> corpCode (기업형태코드) : {{bizCheckInfo.corpCode}}</li>
          <li> corpScaleCode (기업규모코드) : {{bizCheckInfo.corpScaleCode}}</li>
          <li> personCorpCode (개인법인코드) : {{bizCheckInfo.personCorpCode}}</li>
          <li> headOfficeCode (본점지점코드) : {{bizCheckInfo.headOfficeCode}}</li>
          <li> industryCode (산업코드) : {{bizCheckInfo.industryCode}}</li>
          <li> establishCode (설립구분코드) : {{bizCheckInfo.establishCode}}</li>
          <li> establishDate (설립일자) : {{bizCheckInfo.establishDate}}</li>
          <li> CEOName (대표자명) : {{bizCheckInfo.ceoname}}</li>
          <li> workPlaceCode (사업장구분코드) : {{bizCheckInfo.workPlaceCode}}</li>
          <li> addrCode (주소구분코드) : {{bizCheckInfo.addrCode}}</li>
          <li> zipCode (우편번호) : {{bizCheckInfo.zipCode}}</li>
          <li> addr (주소) : {{bizCheckInfo.addr}}</li>
          <li> addrDetail (상세주소) : {{bizCheckInfo.addrDetail}}</li>
          <li> enAddr (영문주소) : {{bizCheckInfo.enAddr}}</li>
          <li> bizClass (업종) : {{bizCheckInfo.bizClass}}</li>
          <li> bizType (업태) : {{bizCheckInfo.bizType}}</li>
          <li> result (결과코드) : {{bizCheckInfo.result}}</li>
          <li> resultMessage (결과메시지) : {{bizCheckInfo.resultMessage}}</li>
          <li> closeDownTaxType (사업자과세유형) : {{bizCheckInfo.closeDownTaxType}}</li>
          <li> closeDownTaxTypeDate (과세유형전환일자) : {{bizCheckInfo.closeDownTaxTypeDate}}</li>
          <li> closeDownState (휴폐업상태) : {{bizCheckInfo.closeDownState}}</li>
          <li> closeDownStateDate (휴폐업일자) : {{bizCheckInfo.closeDownStateDate}}</li>
          {% endif %}
        </ul>
        </ul>
    </fieldset>
</div>
</html>

4. 결과 확인

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