[Zendesk] 문서 API 연동(export csv /json)

업무 중 Helpdesk 콘텐츠라고 하여 FAQ 관련하여 작성하는 콘텐츠가 있다
외국 플랫폼 Zendesk를 사용하는데, 헬프데스크 콘텐츠를 Articles 이라고 부르며
제품 별로 브랜드를 추가하여 각각의 콘텐츠를 관리할 수 있다.

좋은 플랫폼이 있음에도 불구하고 내부적으로는 수백 개의 콘텐츠 리스트를
관리하기가 불편한 상황이 발생하였고 결론적으로 문서로 보관하려면 Export가 필요하다고 생각했다
쉽게 가져오는 방법을 구현하기로 맘 먹었다

초안은 급한 맘에 눈에 보이는 Python으로 구현 하였고 해당 방법을 공유하려한다.
각 브랜드별 Articles을 어떻게 불러오는지 몰라 3시간을 고민했는데
검색해서 찾긴 어려웠지만 알고 보면 쉬운 부분이라 해당 내용을 공유하고자 한다

(*2번 참조 후 1번)

0. 시작하기 전

Zendesk API 가이드 (Help center) : https://developer.zendesk.com/rest_api/docs/help_center/articles
개발 툴 : vs code
사용 언어 : python , json

 

1. 특정 브랜드 Articles 추출하기 ( .csv )

import requests
import sys
import io
import os
import datetime
import csv

sys.stdout = io.TextIOWrapper(sys.stdout.detach(), encoding = 'euc-kr')
sys.stderr = io.TextIOWrapper(sys.stderr.detach(), encoding = 'euc-kr')

# Credentials, please set to correct username and password
credentials = 'ID정보', '비밀번호'

# Your Zendesk URL
# 브랜드 domain 기재 : 브랜드별 주소를 알아야 해당 articles을 가져올 수 있음
zendesk = 'https://{site-domain}.zendesk.com' 

#index 처리
idx = 1
language = 'ko'

# Makes backup path
date = datetime.date.today()
backup_path = os.path.join(str(date), language)
if not os.path.exists(backup_path):
    os.makedirs(backup_path)

# For CSV logging
log = []

articles = zendesk + '/api/v2/help_center/{locale}/articles.json'.format(locale=language.lower())
sections = zendesk + '/api/v2/help_center/{locale}/sections.json'.format(locale=language.lower())
categories = zendesk + '/api/v2/help_center/{locale}/categories.json'.format(locale=language.lower())

# First retrive the sections and categories JSON data
response = requests.get(sections, auth=credentials)
if response.status_code != 200:
    print('Failed to retrieve sections with error {}'.format(response.status_code))
    exit()

sections = response.json()

response = requests.get(categories, auth=credentials)
if response.status_code != 200:
    print('Failed to retrieve categories with error {}'.format(response.status_code))
    exit()

categories = response.json()

# Begin the article process
while articles:
    response = requests.get(articles, auth=credentials)
    if response.status_code != 200:
        print('Failed to retrieve articles with error {}'.format(response.status_code))
        exit()

    data = response.json()

    for article in data['articles']:
        if article['body'] is None:
            continue
		
        #활성화된 게시물만 보기
        if article['draft'] == True:
            continue
            
        for section in sections['sections']:
            if section['id'] == article['section_id']:
                sectionsname = section['name']
                categoriesid = section['category_id']

        for category in categories['categories']:
            if category['id'] == categoriesid:
                categoriesname = category['name']

        print('{id} copied!'.format(id=article['id']))
        #필요한 정보 (설정)
        log.append((idx, categoriesname, sectionsname, article['title'], article['body'], article['html_url'], article['created_at'], article['edited_at']))
        idx = idx + 1
    articles = data['next_page']

# Write to CSV
filename = 'zendesk.csv'

with open(os.path.join(backup_path, filename), mode='w', encoding='utf-8') as f:
    writer = csv.writer(f)
    
    #실제 파일에 쓸때 각 필드 title
    writer.writerow( ('idx', 'Category', 'Section', 'Title', 'Body', 'Url', 'Create_date', 'Update_date') )
    
    for article in log:
        writer.writerow(article)

 

2. 브랜드 별 정보 가져오기

#brands 도메인 불러오기 
zendesk = 'https://{root-domain}.zendesk.com' #젠데스크 브랜드 도메인 입력

#brand별 도메인을 찾아야 각 제품 articles에 대한 request를 받아 올 수 있다.
brands = zendesk + '/api/v2/brands.json'.format(locale=language.lower())

response = requests.get(brands, auth=credentials)
if response.status_code != 200:
    print('Failed to retrieve sections with error {}'.format(response.status_code))
    exit()
#브랜드 정보 확인하는 json
brands = response.json()

 

3. HTML 형태로 저장하기

# Reserved for HTML processing
title = '<h1>' + article['title'] + '</h1>'
filename = '{id}.html'.format(id=article['id'])

with open(os.path.join(backup_path, filename), mode='w', encoding='utf-8') as f:
     f.write(title + '\n' + article['body'])
        

 

! 최종 주의점

1. brands가 여러개일 경우 각 브랜드별 domain으로 등록해야한다. 단, 정확한 domain 정보는 json을 통해 받아와야 한다
2. 나는 mac에서 구현하였는데 windows에서 csv를 excel로 열 경우 인코딩 오류가 존재한다

나의 최종 목적은 db화 시켜서 추가/삭제까지 관리가 가능하고, CS 툴에 잘 녹여 사용 되었으면 좋겠다