[Ruby - Rails] SDK 적용방법 | 링크허브 개발가이드

[Ruby – Rails] SDK 적용방법

2019.04.02

본 개발가이드는 팝빌에서 제공하는 전자세금계산서 API, 전자명세서 API, 현금영수증 API, 문자 API, 팩스 API, 휴폐업조회 API를 쉽고 빠르게 시스템에 연동할 수 있도록, 전자세금계산서 API 예제를 통해 ‘SDK 이용방법’과 ‘상업용 환경설정’ 방법을 상세히 안내드립니다.

Ruby V2.3.0 이상 지원
Ruby On Rails V5.2.3 기반으로 제작
API 호출과 응답에 사용되는 메시지 인코딩 방식은 “UTF-8 Character-Set” 적용

1. SDK 이용방법 안내

SDK를 이용하기 위해서는 팝빌 API 서비스 Gem 추가를 위한 ‘bundle install’ 과 통신전문 보안에 사용되는 ‘인증정보 설정’ 이 필요합니다. 다음의 설명에 따라 SDK를 이용하시기 바랍니다.

bundle install

예제 프로젝트에 팝빌 API 서비스 Gem 추가를 위해서 “Gemfile” 파일에 다음의 코드가 추가되어 있는지 확인하고 gem 라이브러리 설치를 위해 ‘bundle install’ 를 진행합니다. Gem 설치후 이후 rvm list에서 popbill 과 linkhub Gem이 정상적으로 설치되었는지 확인합니다.

source 'https://rubygems.org'

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

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

...
...
...

source 'https://rubygems.org'

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

gem 'rails', '5.2.3'

# 팝빌 API Service

gem 'popbill', '1.9.1'

...

인증정보 설정

bundle install 이후 컨트롤러 파일에 사업자번호(TestCorpNum)와 회원아이디(TestUserID)를 테스트 개발환경(https://test.popbill.com) 가입시 기재한 정보로 수정하고 링크아이디(LinkID)와 비밀키(SecretKey)를 링크허브 가입시 발급받은 링크아이디와 비밀키로 수정하면 인증정보 설정이 완료됩니다.

[참고] 팝빌 테스트용 연동회원 가입절차 안내 [http://test.popbill.com] [바로가기]

require 'popbill/taxinvoice'

class TaxinvoiceController < ApplicationController

  # 링크아이디
  LinkID = "TESTER"

  # 비밀키
  SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I="

  # 팝빌 연동회원 사업자번호
  TestCorpNum = "1234567890"

  # 팝빌 연동회원 아이디
  TestUserID = "testkorea"

  # 팝빌 전자세금계산서 API Service 초기화
  TIService = TaxinvoiceService.instance(
    TaxinvoiceController::LinkID,
    TaxinvoiceController::SecretKey
  )

  # 연동환경 설정, true-개발용, false-상업용
  TIService.setIsTest(true)

require 'popbill/taxinvoice'

class TaxinvoiceController < ApplicationController

# 링크아이디

LinkID = "TESTER"

# 비밀키

SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I="

# 팝빌 연동회원 사업자번호

TestCorpNum = "1234567890"

# 팝빌 연동회원 아이디

TestUserID = "testkorea"

# 팝빌 전자세금계산서 API Service 초기화

TIService = TaxinvoiceService.instance(

TaxinvoiceController::LinkID,

TaxinvoiceController::SecretKey

)

# 연동환경 설정, true-개발용, false-상업용

TIService.setIsTest(true)

2. 상업용 환경설정

테스트 완료 후 연동환경을 상업용으로 설정하기 위해서는 controller 파일에 setIsTest 값을 “false” 로 처리하면 상업용 연동환경 설정이 완료됩니다.

require 'popbill/taxinvoice'

class TaxinvoiceController < ApplicationController

  # 링크아이디
  LinkID = "TESTER"

  # 비밀키
  SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I="

  # 팝빌 연동회원 사업자번호
  TestCorpNum = "1234567890"

  # 팝빌 연동회원 아이디
  TestUserID = "testkorea"

  # 팝빌 전자세금계산서 API Service 초기화
  TIService = TaxinvoiceService.instance(
    TaxinvoiceController::LinkID,
    TaxinvoiceController::SecretKey
  )

  # 연동환경 설정, true-개발용, false-상업용
  TIService.setIsTest(false)