튜토리얼
Ruby 개발환경에서 팝빌 SDK를 추가하고, 전자명세서 즉시 발행 (RegistIssue) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.
1. POPBiLL SDK 추가
섹션 제목: “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 Servicegem 'popbill', '1.52.0'
# 생략# ...2. POPBiLL SDK 설정
섹션 제목: “2. POPBiLL SDK 설정”프로젝트에 전자명세서 서비스 기능을 수행할 Controller를 생성합니다.
rails generate controller tutorialController에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 전자명세서 서비스 객체를 생성 합니다.
require 'popbill/statement'
class StatementController < ApplicationController
# API Key# - 연동신청 시 발급받은 인증 정보(LinkID, SecretKey로 구성)# • LinkID: 파트너를 식별하기 위한 고유 식별자# • SecretKey: API 인증토큰 발급에 사용되는 키## TODO: 아래 LinkID, SecretKey를 발급받은 정보로 교체해 주세요.LinkID = "TESTER"SecretKey = "SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="
# 전자명세서 서비스 객체 초기화STMTService = StatementService.instance( StatementController::LinkID, StatementController::SecretKey)
# 연동환경(테스트/운영) 설정# - 연동환경을 테스트 또는 운영으로 설정합니다.# • true: 테스트 환경으로 설정# • false(default) : 운영 환경으로 설정## ※ 운영전환 이후부터 IsTest 설정 변경만으로 자유롭게 환경 전환(테스트<->운영)이 가능합니다.STMTService.setIsTest(true)
# 인증토큰 IP 일치 검증 사용 여부# - 인증토큰을 발급받은 IP와, 그 토큰을 사용하여 API를 호출하는 IP가 같은지를 검사합니다.# (토큰이 외부로 유출되어도 다른 IP에서는 사용하지 못하도록 막는 보안 장치)# • true(사용, default) : 두 IP가 일치할 때만 API 호출 허용# • false(미사용) : IP 일치 검사를 생략## ※ false는 토큰 발급 시점의 IP와 API 호출 시점의 IP가 달라질 수 있는 환경에서 사용# 예) 오토스케일링, 로드밸런서, NAT 등으로 호출 IP가 유동적인 클라우드 환경STMTService.setIpRestrictOnOff(true)
# 통신 IP 고정 여부# - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.# • true(사용) : 고정(Static) IP 사용# • false(미사용, default) : 가변(Elastic) IP 사용## ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.# (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)STMTService.setUseStaticIP(false)
# 로컬시스템 시간 사용 여부# - 현재시각 기준을 설정합니다.# • true(사용, default) : 로컬시스템 시간 사용# • false(미사용) : 팝빌 서버의 시간을 사용## ※ 현재시각은 주로 인증토큰 발급 및 만료 판단 등에 사용됩니다.# ※ 이 설정은 홈택스 수집 기간, 세금계산서 작성일자, 발행일자 같은 업무 데이터의 날짜값을 변경하는 옵션이 아닙니다.# ※ 로컬 서버 시간이 정상 동기화되어 있으면 일반적으로 true를 사용하고 서버 시간 오차로 인증 실패가 의심되거나# 서버 시간을 신뢰하기 어려운 환경이면 false를 사용합니다.STMTService.setUseLocalTimeYN(true)
end3. RegistIssue 기능 구현
섹션 제목: “3. RegistIssue 기능 구현”Controller 코드에 전자명세서 즉시 발행 (RegistIssue) 함수 호출 코드를 추가합니다.
def registIssue
# 팝빌회원 사업자번호 corpNum = "1234567890"
# 전자명세서 종류코드, 121-거래명세서, 122-청구서, 123-견적서, 124-발주서, 125-입금표, 126-영수증 itemCode = 121
# 전자명세서 문서번호 mgtKey = "20250314-001"
# 전자명세서 정보 statement = {
# [필수] 전자명세서 종류코드, 121-거래명세서, 122-청구서, 123-견적서, 124-발주서, 125-입금표, 126-영수증 "itemCode" => itemCode,
# 맞춤양식코드, 공백처리시 기본양식으로 작성 "formCode" => "",
# [필수] 문서번호, 숫자, 영문, '-', '_' 조합 (최대24자리)으로 사업자별로 중복되지 않도록 구성 "mgtKey" => mgtKey,
# [필수] 기재상 작성일자, 날짜형식(yyyyMMdd) "writeDate" => "20250314",
# [필수] 과세형태, {과세, 영세, 면세} 중 기재 "taxType" => "과세",
# [필수] {영수, 청구, 없음} 중 기재 "purposeType" => "영수",
# [필수] 공급가액 합계 "supplyCostTotal" => "20000",
# [필수] 세액 합계 "taxTotal" => "2000",
# 합계금액, 공급가액 합계 + 세액 합계 "totalAmount" => "22000",
# 기재 상 일련번호 "serialNum" => "",
# 사업자등록증 이미지 첨부여부 "businessLicenseYN" => false,
# 통장사본 이미지 첨부여부 "bankBookYN" => false,
# 발행시 알림문자 전송여부 "smssendYN" => false,
# 비고 "remark1" => "비고1", "remark2" => "비고2", "remark3" => "비고3",
######################### 발신자 정보 #########################
# 발신자 사업자번호 "senderCorpNum" => "1234567890",
# 발신자 상호 "senderCorpName" => "발신자 상호",
# 발신자 대표자 성명 "senderCEOName" => "발신자 대표자명",
# 발신자 종사업장 식별번호, 필요시 기재, 형식은 숫자 4자리 "senderTaxRegID" => "",
# 발신자 주소 "senderAddr" => "발신자 주소",
# 발신자 종목 "senderBizClass" => "발신자 종목",
# 발신자 업태 "senderBizType" => "발신자 업태",
# 발신자 담당자 성명 "senderContactName" => "발신자 담당자명",
# 발신자 담당자 메일주소 "senderEmail" => "test@test.com",
# 발신자 담당자 연락처 "senderTEL" => "070-4304-2991",
# 발신자 담당자 휴대폰번호 "senderHP" => "010-1234-1234",
######################### 수신자 정보 #########################
# 수신자 사업자번호 "receiverCorpNum" => "8888888888",
# 수신자 상호 "receiverCorpName" => "수신자 상호",
# 수신자 대표자 성명 "receiverCEOName" => "수신자 대표자 성명",
# 수신자 주소 "receiverAddr" => "수신자 주소",
# 수신자 종목 "receiverBizClass" => "종목",
# 수신자 업태 "receiverBizType" => "업태",
# 수신자 담당자 성명 "receiverContactName" => "수신자 담당자명",
# 수신자 담당자 메일주소 # 팝빌 개발환경에서 테스트하는 경우에도 안내 메일이 전송되므로, # 실제 거래처의 메일주소가 기재되지 않도록 주의 "receiverEmail" => "test2@test.com",
# 수신자 담당자 연락처 "receiverTEL" => "070-4304-2999",
# 수신자 담당자 휴대폰번호 "receiverHP" => "010-111-222",
######################### 상세항목(품목) 정보 ######################### # serialNum(일련번호) 1부터 순차기재 (배열 길이 제한 없음) ##################################################################
"detailList" => [ { "serialNum" => 1, # 일련번호 1부터 순차기재 "purchaseDT" => "20250314", # 거래일자 yyyyMMdd "itemName" => "테스트1", # 품명 "spec" => "규격", # 규격 "unit" => "단위", # 단위 "qty" => "1", # 수량 "unitCost" => "10000", # 단가 "supplyCost" => "10000", # 공급가액 "tax" => "1000", # 세액 "remark" => "비고", # 비고 }, { "serialNum" => 2, # 일련번호, 1부터 순차기재 "purchaseDT" => "20250314", # 거래일자 yyyyMMdd "itemName" => "테스트1", # 품명 "spec" => "규격", # 규격 "unit" => "단위", # 단위 "qty" => "1", # 수량 "unitCost" => "10000", # 단가 "supplyCost" => "10000", # 공급가액 "tax" => "1000", # 세액 "remark" => "비고", # 비고 }, ],
######################### 전자명세서 추가속성 ######################### "propertyBag" => { "CBalance" => "15000", "Deposit" => "5000", "CBalance" => "20000", } } # end of statement Hash
begin @Response = StatementController::STMTService.registIssue( corpNum, statement, ) render "home/response" rescue PopbillException => pe @Response = pe render "home/exception" endend4. API 응답결과 확인
섹션 제목: “4. API 응답결과 확인”API 호출 응답결과는 다음과 같습니다.
| 구분 | 응답 |
|---|---|
| 성공 | code : 1 |
| 실패 | code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지 |