[Zendesk 고도화] API 활용하기 #6
#6 Talend API Tester로 젠데스크 티켓 만들기 2
지난 시간에는 Talend API Tester를 통해 빠르게 티켓을 생성하는 방법에 대해 이야기해보았습니다.
자세한 설명 없이 진행된 것들이 많아 신기하기도 하고 생소한 부분도 많이 있었을 텐데요.
이번 시간에는 지난 시간에 했단 티켓 생성 절차를 조금 더 자세하게 살펴보고, 함께 알아두면 좋은 IT 지식들도 함께 이야기해보겠습니다.
Talend API Tester를 통해 젠데스크 티켓을 생성해야 할 때 입력해야 항목은 크게 4가지였습니다.
#1 매서드, #2 리소스, #3 헤더는 API 종류 중의 하나인 REST API와 관련된 내용입니다.
REST API에 대한 내용 이미 이전 시간(바로가기)에 간단하게 소개했었고, 인터넷에 너무 많기 때문에 별도로 소개하지는 않겠습니다.
#1 매서드와 #2 리소스에 대한 소개는 이 영상으로 대체해보겠습니다. (바로가기)
#3 헤더에 대한 부분은 우리 수준에 맞게 나와 있는 자료를 찾기가 어려웠는데요.
일단 한번 저장해 두면 변경되는 값은 아니기 때문에 반드시 이해하고 넘어가야 하는 내용은 아닙니다.
현재 수준에서는 두 가지 정도만 이해하고 넘어가면 좋을 것 같습니다.
1. REST API에서는 서버와 클라이언트가 정보를 주고받을 때 헤더와 바디에 내용을 담아서 통신한다.
2. #3에서 사용한 헤더는 아래와 같은 의미를 가지고 있다.
- Content-Type : application/json -> 서버와 정보를 JSON이라는 형태로 주고받겠다.
- Authorization : Basic emVuZay5 hZ -> 젠데스크 서버에 인증하도록 계정과 비밀번호를 알려주겠다.
#4에 대한 내용이 오늘 이야기하고 싶은 부분입니다.
앞 시간에 실습한 것과 같이 BODY 부분에 티켓 생성 시 필요한 제목, 내부메모 등의 정보를 포함해서 젠데스크 서버에 전달하게 되는데요.
이때 JSON이라는 방식을 사용하여 정보를 전달해야 합니다.
JSON에 대한 소개는 아래 영상과 블로그로 대체하고자 합니다.
- JSON 기초 개념 (바로가기)
- JSON 문법 소개 #1 (바로가기)
- JSON 문법 소개 #2 (바로가기)
- JSON 문법 소개 #3 (바로가기)
#4의 JSON 문법을 어느 정도 이해했다고 가정하고 BODY에 대해 이야기를 계속해볼까요?
BODY에 포함된 항목을 보면 제목과 코멘트를 입력하도록 되어 있는데요.
만약 티켓을 생성함과 동시에 티켓 상태를 대기(Pending) 상대로 만들고 싶다면 BODY항목을 어떻게 바꾸어주면 좋을까요?
위와 같이 , "status":"pending" 을 입력하면 됩니다.
그럼 티켓 필드의 값도 API를 통해 추가하는 것이 가능할까요?
티켓 브랜드나 담당자를 변경하는 것도 가능할까요?
API를 통해 제어 가능한 범위는 어디까지일까요?
이런 궁금증을 해결하려면 아래의 링크를 활용해서 api-reference 페이지에 방문해야 합니다
https://developer.zendesk.com/api-reference/
링크 이름에서도 알 수 있듯이 이 사이트는 개발자들이 API를 통해 젠데스크를 어떻게 제어할 수 있는지를 알려주는 일종의 설명서입니다.
왼쪽 메뉴에서 보면 Ticketing 항목이 보이는데요.
항목을 클릭하고 Tickets 항목을 클릭하면 티켓 제어와 관련된 API들이 표시됩니다.
스크롤을 아래쪽으로 주욱 내리다면 Create Ticket이라는 항목이 보이는데요.
위에서 우리가 했던 새로운 티켓을 만드는 방법을 설명한 영역입니다.
내용이 어렵게 느껴지실 수도 있지만, 찬찬히 살펴보면 우리가 했던 작업들을 일목 요연하게 정리해 둔 것을 알 수 있습니다.
#1 티켓을 생성하기 위해서는 POST 메서드를 사용해야 하고, /api/v2/tickets URL을 사용해야 한다고 알려주고 있습니다.
#2 이 API는 상담사 레벨부터 사용이 가능하다고 설명하고 있습니다. ( 티켓 삭제 등의 중요한 작업은 admin으로 표시되어 있는 경우도 있습니다.)
#3 티켓을 생성하는 Body의 샘플을 보여주고 있습니다.
어떠신가요?
위에서 했던 작업들과 연결하여 이해가 되시나요?
즉 내가 사용하고 싶은 API가 있다면 이 api-reference 페이지를 활용하기만 하면 됩니다.
API를 활용한 티켓 생성을 이야기해 보았습니다.
API를 통해 티켓을 생성하는 것이 기존에 젠데스크에서 직접 생성하던 것과는 달라 많이 생소하셨을 수도 있고, 좋은 사용 사례를 생각해 보셨을 수도 있을 것 같은데요.
앞으로는 API를 통해 기존 티켓을 수정하는 방법에 대해 이야기해보고자 합니다.
감사합니다.
