L'API REST Notiondesk permet à votre propre code de gérer vos centres d'aide. Vous pouvez ainsi lister vos centres d'aide, consulter leurs articles, collections et historique des modifications, gérer les redirections de pages, modifier les paramètres et l'image de marque, récupérer les données analytiques et les commentaires des lecteurs, et déclencher des synchronisations depuis Notion.
Cet article explique ce que l'API Notiondesk peut faire, qui peut l'utiliser et comment effectuer votre première requête en quelques minutes.
Que pouvez-vous faire avec l'API Notiondesk ?
| Tâche | Exemple | Guide |
|---|---|---|
| Consultez vos centres d'aide | Répertoriez tous les centres d'aide de votre espace de travail et leurs langues. | Consultez vos centres d'aide |
| Lire le contenu | Exportez chaque article au format Markdown ou listez vos entrées de journal des modifications | Consultez les articles, les collections et les entrées du journal des modifications |
| Publier les modifications de Notion | Synchronisez votre centre d'aide à partir d'un pipeline CI après avoir modifié Notion. | Synchronisations Trigger Notion |
| Gérer les redirections | Importez des centaines de redirections après une migration depuis un autre centre d'aide. | Gérer les redirections de page |
| Changer de langue | Ajouter une langue ou activer la traduction automatique | Gestion des langues et traduction automatique |
| Modifier les paramètres | Mettez à jour les titres SEO, llms.txt, le formulaire de contact ou le journal des modifications. | Mettre à jour les paramètres du centre d'aide |
| Changer l'image de marque | Appliquez les couleurs et le thème de votre marque à plusieurs centres d'aide. | Personnalisez l'image de marque et les thèmes |
| Gérer les intégrations | Configurer Google Analytics, Plausible, Intercom ou Crisp | Gérer les intégrations |
| Analyse des données d'extraction | Envoyez les visiteurs, les recherches et les articles les plus populaires vers votre outil de BI. | Obtenez des analyses du centre d'aide |
| Lire les commentaires | Envoyer chaque matin des réactions négatives aux articles sur Slack | Commentaires des lecteurs d'exportation |
Pour des scripts prêts à l'emploi, consultez Automatiser les tâches courantes du centre d'aide avec l'API Notiondesk .
Qui peut utiliser l'API Notiondesk
- Formule : L’accès à l’API est inclus dans les formules Entreprise.
- Création de clés : Les propriétaires et administrateurs d’espace de travail créent des clés API dans le tableau de bord.
- Autorisations : Une clé ou une application ne peut jamais faire plus que la personne qui la détient dans votre espace de travail. Consultez la section « S’authentifier auprès de l’API Notiondesk à l’aide de clés API » .
Effectuez votre première requête API Notiondesk
1. Créez une clé API
Dans votre tableau de bord Notiondesk, ouvrez Paramètres , puis Développeurs > Clés API et cliquez sur Créer une clé . Attribuez-lui un nom, sélectionnez l'étendue de lecture et copiez la clé lorsqu'elle s'affiche. La clé commence par nd_wsk_ et n'est affichée qu'une seule fois.
Stockez-le dans une variable d'environnement :
2. Dressez la liste de vos centres d'aide
La réponse liste tous les centres d'aide de votre espace de travail :
3. Énumérer les articles d'un centre d'aide
Et voilà ! Vous consultez votre centre d'aide directement depuis le code.
Notiondesk Principes de base de l'API
export NOTIONDESK_API_KEY="nd_wsk_..."curl "<https://api.notiondesk.so/sites>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
"full_domain": "help.example.com",
"enabled": true,
"default_locale": "en",
"locales": ["en", "fr"]
}
],
"has_more": false,
"next_cursor": null
}curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"| Sujet | Ce qu'il faut savoir |
|---|---|
| URL de base | https://api.notiondesk.so |
| Authentification | Authorization: Bearer <key or access token>. Voir les clés API et OAuth |
| Lunettes de visée | read, write, sync et admin. Chaque itinéraire nécessite un |
| Versionnage | En-tête nd-version facultatif |
| Format | Corps de requête et de réponse JSON avec des noms de champs en snake_case |
| Pagination | Basé sur le curseur : page_size (de 1 à 100, 20 par défaut) et cursor. Voir Pagination et demandes de version |
| Erreurs | Une enveloppe JSON contenant un en-tête code lisible par machine. Voir Gestion des erreurs, des limites de débit et des nouvelles tentatives. |
Notiondesk API ou Workspace MCP ?
Notiondesk propose deux façons d'accéder à vos centres d'aide en dehors du tableau de bord. Ils permettent d'accéder aux mêmes fonctionnalités par des voies différentes.
| API REST Notiondesk | Espace de travail MCP | |
|---|---|---|
| Qui l'appelle ? | Votre code : scripts, pipelines CI, outils internes, applications partenaires | Un assistant IA tel que Claude, ChatGPT, Cursor ou VS Code |
| Comment se connecter | Une clé API d'espace de travail ou un jeton d'accès OAuth | OAuth, via votre client IA |
| Idéal pour | Automatisation répétable et déterministe | Travail de dialogue : « identifier les articles que les lecteurs n'apprécient pas et proposer des solutions ». |
Notiondesk Point de terminaison de l'API
| Méthode | Chemin | Portée | Guide |
|---|---|---|---|
GET | /sites | read | Centres d'aide |
GET | /sites/{site_id} | read | Centres d'aide |
GET | /sites/{site_id}/sync-status | read | Centres d'aide |
GET | /sites/{site_id}/articles | read | Contenu |
GET | /sites/{site_id}/articles/{article_id} | read | Contenu |
GET | /sites/{site_id}/categories | read | Contenu |
GET | /sites/{site_id}/categories/{category_id} | read | Contenu |
GET | /sites/{site_id}/changelog | read | Contenu |
POST | /sites/{site_id}/sync | sync | Synchronisations |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Synchronisations |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Synchronisations |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Synchronisations |
GET | /sites/{site_id}/page-redirects | read | Redirections |
POST | /sites/{site_id}/page-redirects | write | Redirections |
PATCH | /sites/{site_id}/page-redirects/{redirect_id} | write | Redirections |
DELETE | /sites/{site_id}/page-redirects/{redirect_id} | admin | Redirections |
PATCH | /sites/{site_id}/settings/supported-languages | write | Langues |
PATCH | /sites/{site_id}/settings/auto-translate | write | Langues |
PATCH | /sites/{site_id}/settings/content | write | Paramètres |
PATCH | /sites/{site_id}/settings/ai-optimization | write | Paramètres |
PATCH | /sites/{site_id}/settings/contact-form | write | Paramètres |
PATCH | /sites/{site_id}/settings/changelog | write | Paramètres |
GET | /sites/{site_id}/settings/customize | read | Image de marque |
PATCH | /sites/{site_id}/settings/customize | admin | Image de marque |
GET | /sites/{site_id}/themes | read | Image de marque |
GET | /sites/{site_id}/integrations | read | Intégrations |
PATCH | /sites/{site_id}/integrations/{type} | admin | Intégrations |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Intégrations |
GET | /sites/{site_id}/analytics/{report} | read | Analytique |
GET | /sites/{site_id}/feedback | read | Retour |
Questions fréquentes
Puis-je créer ou modifier des articles avec l'API Notiondesk ?
Non. Les articles, les collections et les entrées du journal des modifications sont écrits dans Notion, et chaque synchronisation écrase les données stockées dans Notiondesk. Modifiez la page Notion à l'aide de l'éditeur Notion ou de l'API Notion, puis déclenchez la synchronisation pour publier la modification.
Une seule clé API fonctionne-t-elle pour tous mes centres d'aide ?
Oui. Une clé API d'espace de travail fonctionne pour chaque centre d'aide de cet espace. Chaque requête mentionne le centre d'aide dans son chemin, par exemple /sites/{site_id}/articles.
Où puis-je trouver le site_id du centre d'aide ?
site_id du centre d'aide ?Appelez GET /sites pour afficher la liste de vos centres d'aide avec leur id. Il s'agit également de l'identifiant qui suit /s/ dans la barre d'adresse de votre tableau de bord.