튜토리얼

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/httaxinvoice'

class HTTaxinvoiceController < ApplicationController

# API Key
# - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)
# • LinkID: 파트너를 식별하기 위한 고유 식별자
# • SecretKey: API 인증토큰 발급에 사용되는 키
#
# TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.
LinkID = "TESTER"
SecretKey = "SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="

# 홈택스수집(세금) 서비스 객체 초기화
HTTIService = HTTaxinvoiceService.instance(
  HTTaxinvoiceController::LinkID,
  HTTaxinvoiceController::SecretKey
)

# 연동환경(테스트/운영) 설정
# - 연동환경을 테스트 또는 운영으로 설정합니다.
# • true: 테스트 환경으로 설정
# • false(default) : 운영 환경으로 설정
#
# ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게  환경 전환(테스트<->운영)이 가능합니다.
HTTIService.setIsTest(true)

# 인증토큰 IP 일치 검증 사용 여부
# - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.
#   (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)
# • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용
# • false(미사용) : IP 일치 검사를 생략
#
# ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용
#   예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경
HTTIService.setIpRestrictOnOff(true)

# 통신 IP 고정 여부
# - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
# • true(사용) : 고정(Static) IP 사용
# • false(미사용, default) : 가변(Elastic) IP 사용
#
# ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
#   (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
HTTIService.setUseStaticIP(false)

# 로컬시스템 시간 사용 여부
# - 현재시각 기준을 설정합니다.
# • true(사용, default) : 로컬시스템 시간 사용
# • false(미사용) : 팝빌 서버의 시간을 사용
#
# ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.
# ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.
# ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나
#   서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.
HTTIService.setUseLocalTimeYN(true)

end

3. RequestJob 기능 구현

Controller 코드에 홈택스 전자세금계산서 수집요청 (RequestJob) 함수 호출 코드를 추가합니다.

def requestJob

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

    # 전자세금계산서 유형, SELL-매출, BUY-매입, TRUSTEE-위수탁
    keyType = KeyType::SELL

    # 일자유형, W-작성일자, I-발행일자, S-전송일자
    dType = "S"

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

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

    begin
        @value = HTTaxinvoiceController::HTTIService.requestJob(
            corpNum,
            keyType,
            dType,
            sDate,
            eDate,
        )
        @name = "jobID(접수번호)"
        render "home/response"
    rescue PopbillException => pe
        @Response = pe
        render "home/exception"
    end
end

4. API 응답결과 확인

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

구분	응답
성공	JobID(작업아이디) : 18자리 문자열
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지