튜토리얼

Ruby 개발환경에서 팝빌 SDK를 추가하고, 홈택스 현금영수증 수집요청 (RequestJob) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 Ruby SDK를 추가하기 위해 Rails 프로젝트 "Gemfile" 파일에 팝빌 Ruby Gem SDK 정보를 추가하고 bundle install을 진행합니다.

source 'https://rubygems.org'
git_source(:github) { |repo| "https://github.com/#{repo}.git" }

ruby '2.3.0'

# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
gem 'rails', '~> 5.2.3'

# 팝빌 API Service
gem 'popbill', '1.52.0'

# 생략
# ...

2. POPBiLL SDK 설정

프로젝트에 홈택스수집(현금) 서비스 기능을 수행할 Controller를 생성합니다.

rails generate controller tutorial

Controller에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 홈택스수집(현금) 서비스 객체를 생성 합니다.

require 'popbill/htcashbill'

class HTCashbillController < ApplicationController

# 링크아이디
LinkID = "LinkID"

# 비밀키
SecretKey = "SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="

# 홈택스수집(현금) 서비스 객체 초기화
HTCBService = HTCashbillService.instance(
  HTCashbillController::LinkID,
  HTCashbillController::SecretKey
)

# 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
HTCBService.setIsTest(true)

# 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
HTCBService.setIpRestrictOnOff(true)

# 통신 IP 고정, true-사용, false-미사용, (기본값:false)
HTCBService.setUseStaticIP(false)

# 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
HTCBService.setUseLocalTimeYN(true)

end

3. RequestJob 기능 구현

Controller 코드에 홈택스 현금영수증 수집요청 (RequestJob) 함수 호출 코드를 추가합니다.

def requestJob

    # 팝빌회원 사업자번호
    corpNum = "1234567890"

    # 현금영수증 유형, SELL-매출, BUY-매입
    keyType = KeyType::BUY

    # 시작일자, 표시형식(yyyyMMdd)
    sDate = "20250201"

    # 종료일자, 표시형식(yyyyMMdd)
    eDate = "20250228"

    begin
        @value = TutorialController::HTCBService.requestJob(
            corpNum,
            keyType,
            sDate,
            eDate,
        )
        @name = "jobID(작업아이디)"
        render "home/response"
    rescue PopbillException => pe
        @Response = pe
        render "home/exception"
    end
end

4. API 응답결과 확인

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