Gérez les intégrations du centre d'aide avec l'API Notiondesk

L'API Notiondesk vous permet de lister, configurer et désactiver les intégrations tierces de votre centre d'aide : outils d'analyse, chat en direct et gestionnaires de tags. Utilisez-la pour déployer la même configuration d'analyse ou de chat sur plusieurs centres d'aide à l'aide d'un seul script.

La configuration et la désactivation des fournisseurs nécessitent un plan incluant les intégrations.

Chaque fournisseur charge un script tiers sur chaque page de votre centre d'aide. Un conteneur Google Tag Manager exécute tout ce que son propriétaire publie, et Plausible ou Umami détermine l'emplacement de chargement du script d'analyse. C'est pourquoi la modification des intégrations nécessite une autorisation spéciale. N'accordez une clé qu'aux intégrations de confiance.proxy_urladminadmin

Fournisseurs de services pris en charge

Chaque valeur est une chaîne de caractères de 255 caractères maximum. Aucune n'est secrète : il s'agit d'un identifiant dont le script du fournisseur a besoin sur la page. Notiondesk vérifie le format, mais pas l'identifiant lui-même auprès du fournisseur.

Listez vos intégrations

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Cette liste comprend les fournisseurs désactivés, sans ordre particulier, et tient toujours dans une seule réponse. Un fournisseur jamais configuré est absent.

Configurer un fournisseur

Transmettez les champs du fournisseur à son chemin. La route répond 200 OK avec l'intégration.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Une mise à jour active systématiquement le fournisseur. Le champ enabled n'existe pas : pour désactiver un fournisseur, utilisez la procédure de désactivation.

• Un champ non renseigné conserve sa valeur enregistrée. Pour réactiver un fournisseur configuré sans le modifier, envoyez {}.

• Pour supprimer un proxy, envoyez "proxy_url": null.

• Chaque mise à jour actualise l'intégralité du centre d'aide, en effaçant ses pages en cache et en reconstruisant chaque page.

Remarque : Une valeur enregistrée avant l’application des formats actuels, comme un identifiant Google Analytics ou une valeur qui n’est pas valide, ne sera pas validée. Tant que vous n’aurez pas envoyé une valeur valide pour ce champ, chaque mise à jour de ce fournisseur renverra une erreur 400, y compris les erreurs 400.UA-proxy_urlhttpsvalidation_error{}

Désactiver un fournisseur

La route répond 204 No Content et votre centre d'aide cesse de charger le fournisseur. Ses paramètres sont conservés, la liste l'affiche donc toujours avec enabled: false, et {} envoyé à sa route de mise à jour le réactive.

La désactivation d'un fournisseur déjà désactivé ou d'un fournisseur qui n'a jamais été configuré répond également à 204 et ne change rien, donc une nouvelle tentative est toujours sans risque.

Erreurs

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Consultez la section « Gérer les erreurs d’API Notiondesk, les limites de débit et les nouvelles tentatives » pour connaître l’enveloppe d’erreur et les autres codes.

Questions fréquentes

Et ensuite ?

• Obtenez des analyses du centre d'assistance avec l'API Notiondesk

• Personnalisez l'image de marque et les thèmes du centre d'aide avec l'API Notiondesk

• Authentifiez-vous auprès de l'API Notiondesk à l'aide de clés API.