Existem muitas maneiras de migrar conteúdo de uma central de ajuda para outra. Este artigo concentra-se principalmente no uso da API da sua central de ajuda para importar conteúdo de maneira programática e fornece uma visão geral de alto nível do processo de migração de conteúdo existente para a sua nova central de ajuda. Você também pode migrar conteúdo usando os seguintes métodos:
- Copiar e colar: se você está migrando apenas alguns artigos, a maneira mais rápida e fácil é simplesmente copiar e colar o conteúdo da central de ajuda anterior em um novo artigo.
- Serviços profissionais: se você tem migrações grandes ou complexas, pode contratar a Zendesk para ajudar com sua migração.
- Aplicativos de parceiros: você pode explorar o marketplace de aplicativos da Zendesk para encontrar aplicativos de parceiros, como o Help Desk Migration.
Este artigo abrange os seguintes tópicos:
Migração de conteúdo para a base de conhecimento
A migração de conteúdo de um sistema externo para sua central de ajuda é um processo de várias etapas, em que os dados de uma etapa são necessários para as etapas subsequentes.
O planejamento é crucial. Você precisará mapear a estrutura do conteúdo legado para a estrutura de três camadas da central de ajuda:
Importação de autores como usuários do Zendesk
Primeiro, você deve importar os autores de todos os artigos como usuários do Zendesk com a função de "agente" (um agente no Zendesk não é necessariamente alguém que resolve tickets, consulte Noções básicas sobre as funções de usuário do Zendesk Support).
Para criar usuários do Zendesk com a API, consulte Create user (em inglês). Defina o atributo role como "agent" em cada solicitação POST.
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}Registre o ID de cada usuário porque você precisará dos IDs para definir o atributo author_id de cada artigo criado na central de ajuda.
Se você planeja usar organizações em segmentos de usuários para segregar seções, crie as organizações antes de criar qualquer usuário. Você pode então atribuir o ID da organização ao usuário ao criá-lo. Consulte Create organization (em inglês). Se seus usuários pertencerem a várias organizações, use adesões a organizações para adicionar organizações ao registro de usuário.
Criação de categorias na base de conhecimento
{
"category": {
"id": 37486578,
"name": "Super Hero Tricks",
"description": "This category contains a collection of Super Hero tricks",
"locale": "en-us",
"position": 2,
...
}
}Registre o ID de cada categoria porque quando você criar seções posteriormente precisará dos IDs para atribuir seções a categorias específicas.
Criação de segmentos de usuário (opcional)
Se quiser restringir o acesso a determinadas seções na central de ajuda, você pode atribuir segmentos de usuário às seções. Consulte Create user segment (em inglês).
{
"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
}
}Registre o ID de cada segmento de usuário porque quando você criar seções posteriormente precisará do ID do segmento para atribuir restrições de acesso às seções.
Criação de seções nas categorias
category_id e user_segment_id, se houver, em cada solicitação POST. O Zendesk retorna uma resposta JSON com o novo ID da seção:{
"section": {
"id": 3457836,
"name": "Avionics",
"description": "This section contains articles on flight instruments",
"locale": "en-us",
"category_id": 3465,
...
}
}Registre o ID de cada seção porque quando você criar artigos posteriormente precisará dos IDs de seção para atribuir artigos a seções específicas.
Criação de artigos nas seções
title e body, defina author_id e section_id em cada solicitação POST.{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}Carregamento de anexos (se necessário)
Se um artigo tiver imagens embutidas que não estejam hospedadas em um servidor de arquivos público, como o Amazon S3, carregue as imagens em sua central de ajuda. Consulte Create unassociated attachment (em inglês). Defina o parâmetro inline como true.
content_url) para o anexo:{
"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
}
}Use content_url para atualizar a URL da imagem no HTML do artigo. Consulte Associate attachments in bulk to article (em inglês).
Importação de comentários de artigos
Migração de conteúdo para a comunidade
A importação de conteúdo da comunidade tem muitas das mesmas considerações que a importação de uma base de conhecimento. Você precisará importar usuários para atribuir autores às publicações. Você também precisará mapear a estrutura do conteúdo legado da comunidade para a estrutura de duas camadas da comunidade da central de ajuda:
Criação de segmentos de usuário (opcional)
Se quiser restringir o acesso a determinados tópicos, você precisará de IDs de segmento de usuário. Consulte Create a user segment (em inglês). Ao criar os tópicos posteriormente, você precisará dos IDs de segmento de usuário para atribuir restrições de acesso aos tópicos.
Importação de tópicos para a comunidade
Se aplicável, defina user_segment_id na solicitação POST. Consulte Create topic (em inglês).
O Zendesk retorna uma resposta JSON com o ID do tópico:
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}Registre o ID de cada tópico porque quando você criar tópicos posteriormente precisará dos IDs dos tópicos para atribuir publicações a tópicos específicos.
Importação de publicações para tópicos
Além de title e details, defina author_id e topic_id em cada solicitação POST. Consulte Create post (em inglês).
Diferentemente dos artigos da base de conhecimento, os autores de publicações da comunidade podem ser agentes ou usuários finais.
Ao criar uma publicação, o autor é automaticamente inscrito em todas as atualizações daquele tópico e será notificado quando uma nova publicação for criada ou atualizada.
Todos os assinantes do mesmo tópico recebem uma notificação por e-mail quando a publicação é criada. Para evitar que os assinantes sejam sobrecarregados com notificações ao importar publicações em massa, inclua um parâmetro notify_subscribers com o valor false em suas solicitações POST.
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}Importação de comentários para publicações
Depois de criar as publicações e obter seus respectivos IDs, agora você pode adicionar os comentários associados. Consulte Create comment (em inglês).
Você só pode criar um comentário por vez. Ao criar um comentário em uma publicação, o autor do comentário é automaticamente inscrito em todas as atualizações daquele tópico e é notificado quando uma nova publicação é criada ou atualizada.
Todos os assinantes do mesmo tópico recebem uma notificação por e-mail quando o comentário é criado. Para evitar que os assinantes sejam sobrecarregados com notificações, inclua um parâmetro notify_subscribers com o valor false em suas solicitações POST.