[Zendesk 고도화] API 활용하기 #2
#2 Zendesk API를 통해 티켓 제어하기 - 기초 2
지난 시간에는 API의 개념과 젠데스크 API를 활용할 때 누릴 수 있는 장점들에 대해 이야기해보았습니다.
이번 시간에는 아주 간단한 방법으로 API를 직접 사용해 보고 API가 어떤 것인지 조금 더 쉽게 이해할 수 있는 시간을 가져보려고 합니다.
API는 절대 개발자의 전유물이 아니며, 여러분의 웹브라우저에서도 쉽게 테스트해볼 수 있는데요.
함께 확인해 보실까요?
아직 젠데스크에서 API를 활용한다는 개념이 익숙하지 않으실 수 있는데요.
간단한 예시를 들어보겠습니다.
1. 브라우저(크롬,사파리,엣지 등등)에 젠데스크에 로그인을 합니다.
2. 위와 같이 젠데스크 주소의 앞부분을 복사합니다.
3. 브라우저의 새로운 탭을 열고, 주소의 앞부분을 붙여 넣기 한 뒤에 /api/v2/tickets/1 를 추가해 줍니다.
3-1. https://[회사도메인명].zendesk.com/api/v2/tickets/1 과 같은 형태로 입력해 주시면 됩니다.
5. 엔터를 입력하여 화면이 어떻게 표시되는지 확인합니다.
내용은 다르지만 대략 위와 같은 화면이 표시되셨을 텐데요.
이로써 여러분은 API를 통해 젠데스크에 티켓 정보를 호출하는 데 성공하셨습니다.
제가요.....??????네 맞습니다.
여러분이 크롬 브라우저에 입력한 주소를 살펴볼까요?
https://[회사도메인명].zendesk.com/api/v2/tickets/1
위 주소는 젠데스크에 API를 호출하는 명령이고,
브라우저는 이 명령을 젠데스크로 보내고 받아온 응답을 여러분의 화면에 표시해 준 것입니다.
그럼 여러분은 어떤 명령을 보내신 걸까요?
입력한 하나씩 어떤 의미인지 살펴볼게요.
1. https://[회사도메인명].zendesk.com -> 우리 회사 젠데스크 서버로 이동해 주세요.
2. /api/ -> API를 호출하고 싶어요.
3./v2/ -> 사용하려는 API 버전은 V2입니다.
4. /tickets/ -> 티켓 정보를 보고 싶어요.
5. 1 -> 1번 티켓의 정보를 보고 싶어요.
웹브라우저는 위와 같이 젠데스크 서버에 요청을 보냈고, 젠데스크 서버는 여러분에 1번 티켓의 정보를 전달해주었습니다.
아직 내용을 모두 알아보기는 어렵겠지만, 젠데스크 서포트에서 1번 티켓을 확인해 보시면 대부분의 내용이 포함되어 있는 것을 알 수 있을 것입니다.
이렇게 젠데스크 인터페이스가 아닌 다른 공간(웹브라우저, 다른 프로그램, 코드 등)에서 젠데스크와 연동하여 정보를 주고받는 작업을 할 때 API가 사용된다고 이해하시면 좋을 것 같습니다.
하지만 위와 같이 정보를 받기는 했지만 가독성이 너무 떨어지는데요.
이를 해결할 수 있는 크롬 확장 프로그램을 하나 소개해드리겠습니다.
JSON View라는 확장 프로그램인데요. (바로가기)
크롬 확장 프로그램 설치 및 사용 방법을 별도로 소개하지는 않겠습니다.
인터넷 검색만으로도 쉽게 확인하실 수 있으니까요. (바로가기)
가독성이 떨어지는 위 양식을 아래와 같이 읽기 편하게 바꾸어주는 프로그램입니다.
확장 프로그램을 설치하고 나니 가독성이 훨씬 좋아졌는데요.
API를 사용해서 전달받은 #1 티켓을 살펴보니 대략 2024-01-21에 만들어졌으며, 제목은 "샘플 티켓: 티켓을 확인하세요"라는 것을 알 수 있습니다.
다만 내부에서 #1 티켓을 조회하게 되면 젠데스크의 인터페이스 각각의 값이 UI에 정리되어 표시되는데 비해 API를 사용할 경우 텍스트 중심으로 출력되었다는 것도 알 수 있는데요.
아래쪽에 custom_fields라는 부분에는 우리가 매크로 시간에 배운 필드 ID와 각 필드 ID에 포함된 값을 확인할 수 있습니다.
어떠셨나요?
젠데스크 API를 사용해 보았지만 아직 떨떠름한 느낌이 많이 남아 있으실 것 같은데요.
지극히 정상입니다.
우리는 간단하게 API가 무엇인지 확인해 보았으며, 차근차근 API 실습을 진행하다 보면 좋은 결과를 만드실 수 있을 것이라고 믿습니다.
다음 시간에는 젠데스크에서 API를 사용하기 위한 환경설정과 외부에서 API 명령을 호출하고 결과를 받아 볼 수 있는 크롬 확장 프로그램의 설치에 대해 이야기해보려고 합니다.
감사합니다.
