튜토리얼

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

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

class EasyFinBankController < ApplicationController

# 링크아이디
LinkID = "LinkID"

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

# 계좌조회 서비스 객체 초기화
EFBService = EasyFinBankService.instance(
  EasyFinBankController::LinkID,
  EasyFinBankController::SecretKey
)

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

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

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

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

end

3. RequestJob 기능 구현

Controller 코드에 계좌 거래내역 수집요청 (RequestJob) 함수 호출 코드를 추가합니다.

##############################################################################
# 계좌 거래내역 수집을 요청합니다.
# - 검색기간은 현재일 기준 90일 이내로만 요청할 수 있습니다.
# - 수집 요청후 반환받은 작업아이디(JobID)의 유효시간은 1시간 입니다.
##############################################################################
def requestJob

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

  # 기관코드
  bankCode = "0048"

  # 계좌번호
  accountNumber = "0000000000"

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

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

  begin
    @value = TestController::EFBService.requestJob(
        corpNum,
        bankCode,
        accountNumber,
        sDate,
        eDate,
    )
    render "test/response"
  rescue PopbillException => pe
    @code = pe.code
    @message = pe.message
    render "test/response"
  end
end

4. 결과 확인

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