[Zendesk 고도화] API 활용하기 #7
#7 Talend API Tester로 젠데스크 티켓 내용 수정하기 1
지난 시간에는 API를 통해 티켓을 생성하는 방법에 대해 이야기해보았습니다.
이번 시간에는 API를 통해 티켓을 수정하는 방법에 대해 이야기해보려고 하는데요.
상담 프로세스를 관리하는 입장에서는 티켓 생성보다는 티켓의 정보를 수정하는 작업을 더 많이 할 수밖에 없는데요.
API를 통해 티켓을 수정할 수 있다면, 프로세스 자동화에 큰 도움이 됩니다.
같이 해볼까요?
티켓의 정보를 수정하려면 기존에 티켓이 생성되어 있어야 합니다.
젠데스크에서 새로운 티켓을 하나 만들어볼까요?
#1. 젠데스크 서포트에서 + 추가 버튼을 클릭합니다.
#2. 신규 > 티켓을 클릭하여 새로운 티켓을 만들어줍니다.
#1 새로 생성된 티켓에서 필드 영역의 필수 항목을 입력합니다.
#2 티켓 제목을 입력합니다.
#3 티켓 내용을 입력합니다.
#4 티켓 상태를 등록으로 변경합니다.
새로운 티켓이 생성되고 나면 아래와 같이 티켓 ID가 부여됩니다.
#1에서 알 수 있듯이 제가 만든 티켓은 ID가 27번입니다.
티켓 생성에서는 새로운 티켓을 만드는 것이기 때문에 젠데스크 서버에서 ID를 부여해 주었지만,
티켓 수정에서는 반대로 어떤 티켓에 정보를 변경할 것인지를 젠데스크 서버에 알려주어야 합니다.
수정할 티켓 샘플을 만들었으니 이제 Talend API Tester에서 티켓 수정 작업을 진행해 보겠습니다.
Scenario 옆의 메뉴 버튼을 클릭해서 Add a request를 선택하게 되면 새로운 API 요청 페이지가 표시됩니다.
그런데 이렇게 요청 창을 새로 만들게 되면 기존에 입력했던 헤더, 메서드 등을 다 다시 입력해야 하는 번거로움이 발생하게 되는데요.
이럴 때는 기존 요청을 복사하여 사용하면 더욱 편리하게 Talend API Tester를 사용할 수 있습니다.
#1 Scenario가 아닌 지난 시간에 생성한 Ticket_create 요청 옆의 메뉴를 클릭합니다.
#2 COPY 항목을 클릭합니다.
새로운 요청을 저장할 장소와 이름을 지정할 수 있는 창이 표시되는데요.
경로는 동일하게 하고, #3에서 요청 이름을 Ticket_update로 변경하고 #4의 Copy 버튼을 클릭합니다.
#5를 통해 새로운 요청이 만들어졌음을 알 수 있습니다.
#6을 통해 기존 요청의 정보를 그대로 가져왔기 때문에 일부 항목만 수정하면 새로운 API 발신이 가능함을 알 수 있습니다.
그럼 이제 새로 만들어진 요청(Ticket_update)을 우리가 원하는 형태로 수정해 볼까요?
첫 번째로 해야 할 작업은 METHOD를 변경하는 것입니다.
티켓을 생성할 때는 POST라는 메서드를 사용하지만, 티켓을 수정할 때는 PUT라는 메서드를 사용합니다.
두 번째는 리소스를 변경하는 것입니다.
티켓을 생성할 때는 https://{{회사도메인}}.zendesk.com/api/v2/tickets 와 같이 입력했었는데요.
위에서 말씀드린 것과 같이 티켓을 수정할 때는 어떤 티켓을 수정할지 티켓 ID를 Zendesk 서버에 알려줘야 합니다.
그래서 티켓을 수정할 때는 https://{{회사도메인}}.zendesk.com/api/v2/tickets/{{티켓ID} 와 같은 형태로 입력하면 됩니다.
저의 경우에는 https://zeno_tech.zendesk.com/api/v2/tickets/27 로 변경하면 됩니다.
세 번째 헤더 영역은 변경할 사항이 없습니다.
네 번째 바디 영역은 일단 제목과 간단한 코멘트와 티켓 상태만 바꿔볼게요.
전체적으로 변경 항목을 적용하면 다음과 같습니다.
#1을 클릭하여 요청을 저장합니다.
#2를 클릭하여 요청을 전송해 볼까요?
이전에 설명드린 것과 같이 녹색 바에 2로 시작하는 숫자가 표시되었다면 요청이 잘 전송되었다는 의미입니다.
젠데스크에서 확인해 보면 티켓에 티켓 상태가 보류로 바뀌고 제목과 내부 메모가 추가된 것을 확인할 수 있습니다.
Talend API Tester로 돌아와서 Send 버튼을 누른 이후 생긴 녹색바 아래쪽을 한번 살펴볼게요.
Response 라고 표시된 영역 안에 녹색 바가 있고, 그 아래쪽에는 내용들이 포함되어 있습니다.
내용 중에는 헤더와 바디라는 항목이 보이는데요.
우리가 요청을 보낼 때도 헤더와 바디가 있었고, 요청을 보내고 난 뒤에 헤더와 바디가 추가로 생성되었음을 알 수 있는데요.
위쪽 영역의 헤더와 바디를 요청 헤더, 요청 바디 라고 부르고 아래쪽의 헤더와 바디는 응답 헤더, 응답 바디라고 부릅니다.
정리하자면,
요청 헤더와 요청 바디에 우리가 젠데스크 서버에 요청하시 싶은 명령을 담아서 보냈고,
젠데스크 서버는 요청 사항을 어떻게 처리했는지 우리에게 알려주기 위해 응답 헤더와 응답 바디에 내용을 담아 보내준 것입니다.
응답 바디 영역을 살펴보면
티켓 ID와 업데이트 날짜(GMT 기준) 제목과 티켓 상태가 표시되어 있는데요.
우리가 요청 바디 영역에 포함했던 사항들이 잘 적용되었다는 것을 굳이 젠데스크에서 티켓을 열어보지 않아도, 응답 바디만으로도 알 수 있는 것이죠.
이번 시간에는 API를 통해 티켓을 간단하게 수정하는 작업을 진행해 보았습니다.
다음 시간에는 API를 통해 필드 영역, 티켓 양식, 공개답장 등 세부적인 항목들을 수정하는 방법에 대해 이야기해볼게요.
감사합니다.
