튜토리얼

Delphi 개발환경에서 팝빌 SDK를 추가하고, 카카오톡 알림톡 전송 (SendATS) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

팝빌 연동자료실에서 Delphi SDK 예제코드 다운로드 후 압축을 해제합니다.

압축해제한 SDK 예제코드에서 Linkhub/ Popbill/ PopbillTaxinvoice/ 각 폴더의 pas파일 3개를 프로젝트 유닛으로 추가합니다.

2. POPBiLL SDK 설정

아래 코드를 참조하여 Form 파일을 수정합니다.

1. ① use 참조유닛 추가
2. ② 인증정보 변수와 서비스 클래스를 선언
3. ③ FormCreate 프로시저에 카카오톡 서비스 클래스 인스턴스 생성 및 초기화

unit Example;

interface

uses
  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,
  StdCtrls, TypInfo, shellapi, ExtCtrls, Grids,
  Popbill, PopbillKakao;

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

var
  // 카카오톡 서비스 객체 선언
  kakaoService : TKakaoService;
// 생략
// ...
// ...

procedure TfrmExample.FormCreate(Sender: TObject);
begin
  // 카카오톡 서비스 객체 초기화
  kakaoService := TKakaoService.Create(LinkID,SecretKey);

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

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

  // 예외 처리 설정, true-사용, false-미사용, (기본값:true)
  kakaoService.IsThrowException := true;

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

3. SendATS 기능 구현

Form에 버튼을 생성하고 버튼의 Click Event 코드에 카카오톡 알림톡 전송 (SendATS) 함수를 추가합니다.

procedure TfrmExample.btnSendATS_oneClick(Sender: TObject);
var
    receiptNum, templateCode, senderNum, altSendType, receiverNum,
    receiverName, content, altContent, requestNum : String;
    Buttons : TSendKakaoButtonList;
    reserveDT : String;
    corpNum : String;
    userID : String;
begin

    // 팝빌회원 사업자번호
    corpNum := '1234567890';

    // 팝빌회원 아이디
    userID := 'testkorea';

    // 알림톡 템플릿코드, ListATSTemplate 함수 반환항목중 templateCode로 확인
    // GetATSTemplateMgtURL(알림톡 템플릿 관리 팝업) 함수를 통해서 확인
    templateCode := '018110000047';

    // 팝빌에 사전 등록된 발신번호
    senderNum := '070-4304-2991';

    // 수신번호
    receiverNum := '010111222';

    // 수신자명
    receiverName := '수신자명';

    // 알림톡 메시지 내용 (최대 1000자)
    // 템플릿의 내용과 일치하지 않은 경우 전송실패
    content := '테스트 알림톡';

    // 대체문자 내용  (최대 2000byte)
    altContent := '대체문자 내용';

    // 대체문자 전송유형, 공백-미전송, C-알림톡전송, A-대체문자 전송
    altSendType := 'A';

    // 알림톡 버튼정보를 템플릿 신청시 기재한 버튼정보와 동일하게 전송하는경우 길이를 0으로 처리
    SetLength(Buttons, 0);

    // 알림톡 버튼 URL에 #{템플릿변수}를 기재한 경우 버튼정보추가 - 템플릿 변수만 변경하여 구성
    //SetLength(Buttons, 1);
    //Buttons[0] := TSendKakaoButton.Create;
    //Buttons[0].buttonName := '버튼명'; // 버튼명
    //Buttons[0].buttonType := 'WL';     // 버튼 DS-배송조회 WL-웹링크 AL-앱링크 MD-메시지전달 BK-봇키워드
    //Buttons[0].buttonURL1 := 'http://www.weblink1.com'; // 버튼링크1  [앱링크] Android / [웹링크] Mobile
    //Buttons[0].buttonURL2 := 'http://www.weblink2.com'; // 버튼링크2  [앱링크] IOS / [웹링크] PC URL
    //Buttons[0].buttonTG := 'out'; // 아웃링크, out - 디바이스 기본 브라우저, 미입력 - 카카오톡 인앱 브라우저

    // 요청번호
    // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
    // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
    requestNum := '';

    // 예약전송일시
    reserveDT := '';

    try
            receiptNum := kakaoService.SendATS(corpNum, templateCode, senderNum, altSendType,
                                                reserveDT, receiverNum, receiverName, content,
                                                altContent, Buttons, userID, requestNum);
    except
            on le : EPopbillException do begin
                    ShowMessage('응답코드 : ' + IntToStr(le.code) + #10#13 +'응답메시지 : '+ le.Message);
                    Exit;
            end;
    end;

    if kakaoService.LastErrCode <> 0 then
    begin
            ShowMessage('응답코드 : ' + IntToStr(kakaoService.LastErrCode) + #10#13 +'응답메시지 : '+ kakaoService.LastErrMessage);
    end
    else
    begin
            txtReceiptNum.Text := receiptNum;
            ShowMessage('접수번호 (receiptNum) : ' + receiptNum);
    end;
end;

4. API 응답결과 확인

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

구분	응답
성공	ReceiptNum(접수번호) : 18자리 문자열
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지