Importation de vos auteurs en tant qu’utilisateurs Zendesk

D’abord, vous devez importer les auteurs de tous vos articles en tant qu’utilisateurs Zendesk avec le rôle d’agent (un agent dans Zendesk n’est pas nécessairement quelqu’un qui résout des tickets). Consultez Rôles des utilisateurs Zendesk Support.

Pour créer des utilisateurs Zendesk avec l’API (consultez Create user), assurez-vous de définir l’attribut role sur « agent » dans chaque demande POST.

{
  "user": {
    "id":   9873843,
    "name": "Roger Wilco",
    ...
  }
}

Enregistrez l’ID de chaque utilisateur, car vous en aurez besoin pour définir l’attribut author_id de chaque article que vous créez dans votre centre d’aide.

Si vous envisagez d’utiliser les organisations dans les segments d’utilisateurs pour séparer les sections, vous devez créer les organisations avant de créer les utilisateurs. Vous pourrez ensuite affecter l’ID de l’organisation à l’utilisateur au moment de sa création (consultez Create organization). Si vous voulez que vos utilisateurs appartiennent à plusieurs organisations, utilisez l’appartenance aux organisations pour ajouter des organisations à l’enregistrement de l’utilisateur.

Création de catégories dans votre base de connaissances

{
  "category": {
    "id":          37486578,
    "name":        "Super Hero Tricks",
    "description": "This category contains a collection of Super Hero tricks",
    "locale":      "en-us",
    "position":    2,
    ...
  }
}

Enregistrez l’ID de chaque catégorie car, quand vous créerez des sections, vous aurez besoin de ces ID pour affecter les sections à des catégories spécifiques.

Création de segments d’utilisateurs (facultatif)

Si vous voulez restreindre l’accès à certaines sections de votre centre d’aide, vous pouvez affecter des segments d’utilisateurs à vos sections (consultez Create user segment).

{
  "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
  }
}

Enregistrez l’ID de chaque segment d’utilisateurs car, quand vous créerez des sections, vous aurez besoin de ces ID pour affecter les restrictions d’accès aux sections.

Création de sections dans vos catégories

{
  "section": {
    "id":          3457836,
    "name":        "Avionics",
    "description": "This section contains articles on flight instruments",
    "locale":      "en-us",
    "category_id": 3465,
    ...
  }
}

Enregistrez l’ID de chaque section car, quand vous créerez des articles, vous aurez besoin de ces ID pour affecter les articles à des sections spécifiques.

Création d’articles dans vos sections

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    "section_id":        98838,
    ...
  }
}

Téléchargement de pièces jointes (si nécessaire)

Si un article contient des images incorporées qui ne sont pas hébergées sur un serveur de fichiers public comme Amazon S3, chargez les images dans votre centre d’aide (consultez Create unassociated attachment). Définissez le paramètre inline sur true.

{
  "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
  }
}

Utilisez content_url pour mettre l’URL de l’image à jour dans le code HTML de l’article (consultez Associate attachments in bulk to article).

Importation des commentaires d’articles

Création de segments d’utilisateurs (facultatif)

Si vous voulez restreindre l’accès à certains sujets, vous aurez besoin des ID des segments d’utilisateurs (consultez Create a user segment). Quand vous créerez les sujets, ces ID vous permettront d’affecter des restrictions d’accès aux sujets.

Importation de sujets dans votre communauté

Le cas échéant, n’oubliez pas de définir user_segment_id dans la demande POST (consultez Create topic).

Zendesk renvoie une réponse JSON avec l’ID du sujet :

{
  "topic": {
    "id":   115000553548,
    "name": "Help Center-Tricks",
    ...
  }
}

Enregistrez l’ID de chaque sujet car, quand vous créerez des sujets, vous aurez besoin de ces ID pour affecter les publications à des sujets spécifiques.

Importation de publications dans les sujets

En plus de title et details, vous devez aussi définir author_id et topic_id dans chaque demande POST (consultez Create post).

Contrairement aux articles de la base de connaissances, les auteurs des publications de la communauté peuvent être des agents ou des utilisateurs finaux.

Quand vous créez une publication, l’auteur est automatiquement abonné à toutes les mises à jour de ce sujet et sera notifié quand une publication est mise à jour ou une nouvelle publication est créée.

Tous les abonnés à un sujet reçoivent une notification par e-mail à sa création. Pour éviter de submerger les abonnés de notifications lors de l’importation de publications en masse, incluez un paramètre notify_subscribers avec une valeur de false dans vos demandes POST.

{
  "post": {
    "id":        35467,
    "author_id": 89567,
    "title":     "Help!",
    "details":   "My printer is on fire!",
    "notify_subscribers": false,
    ...
  }
}

Importation de commentaires dans les publications

Une fois que vous avez créé les publications et obtenu leurs ID, vous pouvez ajouter les commentaires associés (consultez Create comment).

Vous ne pouvez créer qu’un seul commentaire à la fois. Quand vous créez un commentaire pour une publication, l’auteur du commentaire est automatiquement abonné à toutes les mises à jour de ce sujet et sera notifié quand une publication est mise à jour ou une nouvelle publication est créée.

Tous les abonnés à un sujet reçoivent une notification par e-mail à la création du commentaire. Pour éviter de submerger les abonnés de notifications, incluez un paramètre notify_subscribers avec une valeur de false dans vos demandes POST.