다양한 방법을 사용하여 한 헬프 센터에서 다른 헬프 센터로 콘텐츠를 마이그레이션할 수 있습니다. 이 문서는 헬프 센터 API를 사용한 콘텐츠 가져오기를 주로 다루면서 새로운 헬프 센터 지식창고와 커뮤니티로 기존의 콘텐츠를 마이그레이션하는 과정에 대한 개괄적인 개요를 제공합니다. 다음과 같은 방법을 사용하여 콘텐츠를 마이그레이션할 수도 있습니다.
- 복사/붙여넣기 - 몇 개의 문서만 마이그레이션하는 경우에는 이전 헬프 센터에서 콘텐츠를 복사하여 새 Guide 문서로 붙여넣는 것이 가장 쉽고 빠른 방법입니다.
- 전문 서비스 - 대량의 복잡한 마이그레이션을 해야 하는 경우에는 Zendesk 전문가 서비스를 구매하여 마이그레이션에 대한 도움을 받을 수 있습니다.
- 파트너 앱 - Zendesk 앱 마켓플레이스에서 Help Desk Migration 등의 파트너 앱을 찾아볼 수 있습니다.
이 문서에서 다루는 주제는 다음과 같습니다.
콘텐츠를 지식창고로 마이그레이션하기
콘텐츠를 외부 시스템에서 헬프 센터로 마이그레이션하는 것은 여러 단계를 거쳐야 하며, 앞선 단계의 데이터가 다음 단계에서 필수적입니다.
계획을 세우는 것이 중요합니다. 기존 콘텐츠의 구조를 헬프 센터의 3중 계층 구조로 맵핑해야 합니다.
작성자를 Zendesk 사용자로 가져오기
먼저, 모든 문서의 작성자를 "상담원" 역할의 Zendesk 사용자로 가져와야 합니다. Zendesk의 상담원이 반드시 티켓을 해결하는 사람일 필요는 없습니다(Zendesk Support 사용자 역할 이해하기 참조).
API를 통해 Zendesk 사용자를 만들려면 사용자 만들기를 참조하세요. 각 POST 요청에서 role 속성을 반드시 "agent"로 설정하세요.
성공적으로 사용자를 만들면 Zendesk는 JSON 응답에서 사용자의 새로운 ID를 포함한 상세 정보를 리턴합니다.
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}
각 사용자의 ID를 기록하세요. 헬프 센터에서 만드는 각 문서의 author_id 속성을 설정하는 데 ID가 필요합니다.
섹션을 구분하기 위해 사용자 세그먼트에서 조직을 사용하려면 사용자를 만들기 전에 조직을 먼저 만들어야 합니다. 그런 다음 사용자를 만들 때 사용자에게 조직 ID를 배정할 수 있습니다(조직 만들기 참조). 사용자가 여러 조직에 속하는 경우 사용자 레코드에 조직을 추가하려면 조직 구성원을 사용합니다.
지식창고에서 카테고리 만들기
카테고리는 섹션의 모음입니다(카테고리 만들기 참조). 카테고리를 만든 후 Zendesk는 카테고리의 새 ID로 JSON 응답을 리턴합니다.
{
"category": {
"id": 37486578,
"name": "Super Hero Tricks",
"description": "This category contains a collection of Super Hero tricks",
"locale": "en-us",
"position": 2,
...
}
}
각 카테고리의 ID를 기록하세요. 나중에 섹션을 만들 때 섹션을 특정 카테고리에 배정하려면 ID가 필요합니다.
사용자 세그먼트 만들기(선택 사항)
헬프 센터의 특정 섹션에 대한 액세스를 제한하려면 섹션에 사용자 세그먼트를 배정할 수 있습니다(사용자 세그먼트 만들기 참조).
사용자 세그먼트를 만든 후 Zendesk는 사용자 세그먼트의 새 ID로 JSON 응답을 리턴합니다.
{
"user_segment": {
"id": 7284
"name": "VIP agents",
"user_type": "staff",
"group_ids": [12, ...],
"organization_ids": [42, ...],
"tags": ["vip"],
"created_at": "2017-05-21T20:01:12Z",
"updated_at": "2017-05-21T20:01:12Z",
"built_in": false
}
}
각 사용자 세그먼트의 ID를 기록하세요. 나중에 섹션을 만들 때 섹션에 대한 액세스 권한을 제한하려면 세그먼트 ID가 필요합니다.
카테고리에서 섹션 만들기
섹션은 문서의 모음입니다(섹션 만들기 참조). 각 POST 요청에서 반드시 category_id와 user_segment_id(있는 경우)를 설정하세요. Zendesk는 섹션의 새 ID로 JSON 응답을 리턴합니다.
{
"section": {
"id": 3457836,
"name": "Avionics",
"description": "This section contains articles on flight instruments",
"locale": "en-us",
"category_id": 3465,
...
}
}
각 섹션의 ID를 기록하세요. 나중에 문서를 만들 때 문서를 특정 섹션에 배정하려면 섹션 ID가 필요합니다.
섹션에서 문서 만들기
이전 단계에서 모든 섹션 ID와 사용자 ID를 기록했다면 문서를 만들 수 있습니다(문서 만들기 참조). 각 POST 요청에서 title 및 body뿐만 아니라 author_id 및 section_id도 설정해야 합니다.
Zendesk는 다음과 같은 JSON 응답을 리턴합니다.
{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}
첨부 파일 업로드(필요한 경우)
Amazon S3와 같이 공용 파일 서버에 호스팅되지 않은 인라인 이미지가 문서에 포함되어 있는 경우에는 이미지를 헬프 센터에 업로드합니다(연결되지 않은 첨부 파일 만들기 참조). inline 매개변수를 반드시 true로 설정하세요.
Zendesk는 첨부 파일의 URL(content_url)로 JSON 응답을 리턴합니다.
{
"article_attachment": {
"id": 1428,
"article_id": null,
"file_name": "icon.jpg",
"content_url": "https://company.zendesk.com/hc/article_attachments/1428/icon.jpg",
"content_type": "application/image",
"size": 58298,
"inline": true
}
}
content_url을 사용하여 문서의 HTML에서 이미지 URL을 업데이트합니다(첨부 파일을 문서에 일괄 연결하기 참조).
문서 댓글 가져오기
댓글을 가져오려면 작성자 ID와 문서의 ID가 필요합니다. 상담원과 최종 사용자 둘 다 댓글의 작성자일 수 있습니다(댓글 만들기 참조).
콘텐츠를 커뮤니티로 마이그레이션하기
커뮤니티 콘텐츠를 가져오는 것은 지식창고를 가져오는 것과 비슷한 점이 많습니다. 게시물에 작성자를 배정하려면 사용자 가져오기를 해야 합니다. 또한 기존 커뮤니티 콘텐츠를 헬프 센터 커뮤니티의 이중 계층 구조와 맵핑해야 합니다.
사용자 세그먼트 만들기(선택 사항)
특정 주제에 대한 액세스를 제한하려면 사용자 세그먼트 ID가 필요합니다(사용자 세그먼트 만들기 참조). 나중에 주제를 만들 때 주제에 대한 액세스 제한을 배정하려면 사용자 세그먼트 ID가 필요합니다.
주제를 커뮤니티로 가져오기
해당되는 경우, POST 요청에서 반드시 user_segment_id를 설정하세요(주제 만들기 참조).
Zendesk는 주제 ID로 JSON 응답을 리턴합니다.
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}
각 주제의 ID를 기록하세요. 나중에 주제를 만들 때 게시물을 특정 주제에 배정하려면 주제 ID가 필요합니다.
게시물을 주제로 가져오기
각 POST 요청에서 title 및 details뿐만 아니라 author_id 및 topic_id도 설정해야 합니다(게시물 만들기 참조).
지식창고 문서와는 달리 커뮤니티 게시물의 작성자는 상담원 또는 최종 사용자입니다.
게시물을 만들 때 작성자는 해당 주제의 모든 업데이트를 자동 구독하게 되며 새로운 게시물이 만들어지거나 업데이트되면 알림을 받게 됩니다.
게시물이 만들어지면 동일한 주제의 모든 구독자는 이메일 알림을 받습니다. 게시물을 일괄로 가져올 때 구독자들에게 너무 많은 알림을 한꺼번에 보내지 않도록 POST 요청에 notify_subscribers 값을 가진 false 매개변수를 포함시킵니다.
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}
댓글을 게시물로 가져오기
게시물을 만들고 ID를 받은 후 게시물과 연결된 댓글을 추가할 수 있습니다(댓글 만들기 참조).
한 번에 하나의 댓글만 만들 수 있습니다. 게시물 댓글을 만들 때 댓글 작성자는 해당 주제의 모든 업데이트를 자동 구독하게 되며 새로운 게시물이 만들어지거나 업데이트되면 알림을 받습니다.
댓글이 만들어지면 동일한 주제의 모든 구독자는 이메일 알림을 받습니다. 구독자들에게 너무 많은 알림을 한꺼번에 보내지 않도록 POST 요청에 notify_subscribers 값을 가진 false 매게 변수를 포함시킵니다.