튜토리얼

Ruby 개발환경에서 팝빌 SDK를 추가하고, 카카오톡 알림톡 전송 (SendATS) 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/kakao'

class KakaoController < ApplicationController

# 링크아이디
LinkID = "LinkID"

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

# 카카오톡 서비스 객체 초기화
KakaoService = KakaoService.instance(
  KakaoController::LinkID,
  KakaoController::SecretKey
)

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

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

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

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

end

3. SendATS 기능 구현

Controller 코드에 카카오톡 알림톡 전송 (SendATS) 함수 호출 코드를 추가합니다.

def sendATS_one

    # [필수] 팝빌회원 사업자번호
    corpNum = "1234567890"

    # 팝빌회원 아이디
    userID = "testkorea"

    # [필수] 알림톡 템플릿코드 (ListATSTemplate API의 반환 항목 중 templateCode 기재)
    templateCode = '019020000163'

    # [필수] 발신번호 (팝빌에 등록된 발신번호만 이용가능)
    snd = '070-4304-2991'

    # 알림톡 내용 (최대 1000자)
    content = '[ 팝빌 ] 신청하신 템플릿에 대한 심사가 완료되어 승인 처리되었습니다. 해당 템플릿으로 전송 가능합니다.'

    # 대체문자 내용 (최대 2000byte)
    altContent = '대체문자 내용 입니다'

    # 대체문자 유형 (공백-미전송 / C-알림톡내용 / A-대체문자내용)
    altSendType = 'A'

    # 예약일시 (작성형식: 20250101060000 yyyyMMddHHmmss)
    sndDT = ''

    # 수신자명
    receiverName = '수신자명'

    # [필수] 수신번호
    receiver = '010111222'

    # 요청번호, 파트너가 전송요청에 대한 관리번호를 직접 할당하여 관리하는 경우 기재
    # 최대 36자리, 영문, 숫자, 언더바('_'), 하이픈('-')을 조합하여 사업자별로 중복되지 않도록 구성
    requestNum = ''

    begin
        @value = TutorialController::KakaoService.sendATS_one(
            corpNum,
            templateCode,
            snd,
            content,
            altContent,
            altSendType,
            sndDT,
            receiver,
            receiverName,
            requestNum,
            userID,
        )['receiptNum']
        @name = "receiptNum(접수번호)"
        render "home/response"
    rescue PopbillException => pe
        @Response = pe
        render "home/exception"
    end
end

4. API 응답결과 확인

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