튜토리얼

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

1. POPBiLL SDK 추가

[프로젝트 > NuGet 패키지 관리] 메뉴에서 popbill을 검색하여 최신 버전의 패키지를 설치합니다.

2. POPBiLL SDK 설정

① 프로젝트의 Startup.cs 파일에 카카오톡 서비스 인스턴스 클래스를 생성하고, Startup클래스의 ConfigureServices() 함수에 의존성 주입 패턴으로 Singleton 서비스 인스턴스를 추가합니다.

② 카카오톡 서비스명으로 컨트롤러를 생성하고 생성한 컨트롤러의 생성자 함수에서 카카오톡 인스턴스 객체를 할당합니다.

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Popbill.Kakao;

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

  // 카카오톡  서비스 객체 선언
  public KakaoService kakaoService;

  public KakaoInstance()
  {
    // 카카오톡  서비스 객체 초기화
    kakaoService = new KakaoService(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;

    // 통신 IP 고정 여부
    // - 고객사의 보안 정책 또는 방화벽으로 인해 고정 IP로 Outbound 통신을 해야 하는 경우 사용합니다.
    // • true(사용) : 고정(Static) IP 사용
    // • false(미사용, default) : 가변(Elastic) IP 사용
    //
    // ※ true 설정 시, 고정된 IP 또는 도메인을 고객사 방화벽 Outbound 목록에 등록이 필요합니다.
    //   (개발자센터 “가이드 > 공통 > 통신” 페이지에서 확인 가능)
    kakaoService.UseStaticIP = false;

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

namespace KakaoExample
{
  public class Startup
  {
    public Startup(IConfiguration configuration)
    {
      Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
      services.AddMvc();

      services.AddSingleton<KakaoInstance>();
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
      if (env.IsDevelopment())
      {
        app.UseDeveloperExceptionPage();
      }
      else
      {
        app.UseExceptionHandler("/Home/Error");
      }

      app.UseStaticFiles();

      app.UseMvc(routes =>
      {
        routes.MapRoute(
          name: "default",
          template: "{controller=Kakao}/{action=Index}");
      });
    }
  }
}

3. SendATS 기능 구현

카카오톡 서비스명으로 생성한 컨트롤러의 생성자 함수에 인스턴스 객체를 할당하고, 카카오톡 알림톡 전송 함수(SendATS) 호출 코드를 추가합니다.

// Controllers/KakaoController.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

using Popbill;
using Popbill.Kakao;

namespace Tutorial_Example.Controllers
{
    public class KakaoController : Controller
    {
        private readonly KakaoService _kakaoService;

        public KakaoController(KakaoInstance KKOinstance)
        {
            // 카카오 서비스 객체 주입
            _kakaoService = KKOinstance.kakaoService;
        }

        // GET: /<controller>/
        public IActionResult Index()
        {
            return View();
        }

        /*
         * 알림톡 전송을 요청합니다.
         * - 사전에 승인된 템플릿의 내용과 알림톡 전송내용(content)이 다를 경우 전송실패 처리됩니다.
         * - /reference/kakaotalk/dotnetcore/api/send#SendATSOne
         */
        public IActionResult SendATS()
        {
            // 승인된 알림톡 템플릿코드
            string templateCode = "019020000163";

            // 발신번호
            string senderNum = "";

            // 수신번호
            string receiverNum = "";

            // 수신자명
            string receiverName = "수신자명";

            // 알림톡 내용
            string content = "[ 팝빌 ]\n";
            content += "신청하신 #{템플릿코드}에 대한 심사가 완료되어 승인 처리되었습니다.\n";
            content += "해당 템플릿으로 전송 가능합니다.\n\n";
            content += "문의사항 있으시면 파트너센터로 편하게 연락주시기 바랍니다.\n\n";
            content += "팝빌 파트너센터 : 1600-8536\n";
            content += "support@linkhub.co.kr".Replace("\n", Environment.NewLine);

            // 대체문자 제목
            string altSubject = "대체문자 제목";

            // 대체문자 내용
            string altContent = "대체문자 메시지 내용";

            // 대체문자 유형
            string altSendType = "A";

            // 전송 예약일시
            DateTime? sndDT = null;

            // 요청번호
            string requestNum = "";

            // 버튼 목록
            List<KakaoButton> buttons = null;

            // 강조표기 타이틀
            string emphasizeTitle = "";

            /*
            List<KakaoButton> buttons = new List<KakaoButton>();

            KakaoButton btnInfo = new KakaoButton();
            btnInfo.n = "전화 연결";
            btnInfo.t = "TN";
            btnInfo.u1 = "";
            btnInfo.u2 = "";
            btnInfo.tg = "";
            btnInfo.telNum = "1600-8536";
            buttons.Add(btnInfo);
            */

            try
            {
                var receiptNum = _kakaoService.SendATS(corpNum, templateCode, senderNum, altSubject,
                    altSendType, sndDT, receiverNum, receiverName, content, altContent, requestNum,
                    buttons, altSubject, emphasizeTitle, userID);
                return View("Result", receiptNum);
            }
            catch (PopbillException pe)
            {
                return View("PopbillError", pe);
            }
        }
    }
}

4. API 응답결과 확인

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

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