Chaque requête API Notiondesk est authentifiée par un jeton d'authentification : une clé API d'espace de travail ou un jeton d'accès OAuth pour les applications agissant pour le compte d'autres clients Notiondesk. Cet article explique comment créer une clé API Notiondesk, choisir ses autorisations, l'envoyer avec vos requêtes et la renouveler ou la révoquer.
Utilisez une clé API pour les automatisations exécutées dans votre propre espace de travail : script, tâche planifiée, étape d’intégration continue ou outil interne. Si vous développez une application à laquelle d’autres clients Notiondesk se connectent, utilisez plutôt OAuth .
Avant de commencer
- Votre espace de travail est sur un forfait Entreprise.
- Vous êtes le propriétaire de l'espace de travail ou un administrateur.
Créez une clé API Notiondesk
- Dans votre tableau de bord Notiondesk, cliquez sur Paramètres .
- Sous Espace de travail , ouvrez Développeurs , puis Clés API .
- Cliquez sur Créer une clé .
- Saisissez une étiquette indiquant à quoi sert la clé, par exemple
CI automationouRedirect import.
- Sous « Étendues » , sélectionnez uniquement les étendues nécessaires à l’intégration. Voir « Choisir les étendues appropriées » .
- Choisissez une date d'expiration : 30 jours , 90 jours , 1 an ou aucune date d'expiration .
- Cliquez sur Créer .
- Cliquez sur « Copier la clé » et enregistrez-la dans votre gestionnaire de secrets ou vos variables d'environnement.
- Cliquez sur « J'ai enregistré la clé » .
Choisissez les bonnes lunettes de visée
Un scope est une autorisation associée à une clé. Chaque route API Notiondesk requiert un scope, et une clé peut en contenir plusieurs.
| Portée | Description du tableau de bord | Ce qu'elle permet dans l'API REST |
|---|---|---|
read | Consultez le centre d'aide pour en savoir plus sur ses opérations et ses informations. | Consultez les centres d'aide, les articles, les collections, le journal des modifications, les redirections, les paramètres, la personnalisation, les intégrations, l'état de la synchronisation, les analyses et les commentaires. |
write | Gérer la configuration du centre d'aide | Créez et mettez à jour les redirections de pages, et modifiez les paramètres de langue, de traduction automatique, de contenu, d'optimisation par IA, de formulaire de contact et de journal des modifications. |
sync | Déclencher la synchronisation et la traduction du contenu | Déclenchez la synchronisation des sites, des articles et des collections, et activez ou désactivez la synchronisation planifiée. |
admin | Gérer les paramètres de l'espace de travail et la configuration destructive | Supprimer les redirections de pages, modifier l'image de marque et les thèmes, et configurer les intégrations tierces |
Attribuez à chaque intégration le plus petit ensemble de portées dont elle a besoin :
| Intégration | Lunettes de visée |
|---|---|
| Synchroniser le centre d'aide à partir d'un pipeline CI | sync |
| script de tableau de bord analytique ou de reporting | read |
| Résumé des commentaires envoyé à Slack | __PRÉSERVÉ_23__ seulement |
| Rediriger l'importation après une migration | read, write |
| Déploiement de la marque ou de l'intégration dans les centres d'aide | read, admin |
Comment les rôles dans l'espace de travail limitent une clé
Une clé ne peut jamais faire plus que la personne qui l'a créée dans votre espace de travail.
| Rôle actuel du créateur | Portées que la clé peut utiliser |
|---|---|
| Gestionnaire de facturation ou de visionnage | read |
| Éditeur | read, write, sync |
| Administrateur ou propriétaire de l'espace de travail | read, write, sync, admin |
Si le rôle du créateur change, les portées effectives de la clé changent également. Si le créateur quitte l'espace de travail, la clé cesse de fonctionner. Gérez les rôles dans la section « Comment inviter un membre d'équipe » .
Envoyez la clé avec chaque requête
Envoyez la clé dans l'en-tête Authorization avec le schéma Bearer :
Un fichier 200 OK contenant la liste de vos centres d'aide confirme que la clé fonctionne. Une seule clé est valable pour tous les centres d'aide de son espace de travail.
La même requête en JavaScript :
Et en Python :
Conservez votre clé API Notiondesk en lieu sûr.
curl "<https://api.notiondesk.so/sites>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"const response = await fetch("<https://api.notiondesk.so/sites>", {
headers: {
Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
"nd-version": "2026-10-16",
},
});
const sites = await response.json();import os
import requests
response = requests.get(
"<https://api.notiondesk.so/sites>",
headers={
"Authorization": f"Bearer {os.environ['NOTIONDESK_API_KEY']}",
"nd-version": "2026-10-16",
},
)
sites = response.json()- Conservez vos clés sur votre serveur. Ne les intégrez jamais dans le code du navigateur, une application mobile ou un dépôt public.
- Stockez les clés dans des variables d'environnement ou un gestionnaire de secrets, et non dans le code source.
- Créez une clé par intégration, avec sa propre étiquette, afin de pouvoir en révoquer une sans affecter les autres.
- Choisissez une durée de validité pour les clés utilisées par les scripts temporaires.
- Changez de clé lorsqu'une personne qui la connaissait quitte votre équipe.
- Vérifiez la colonne « Dernière utilisation » et révoquez les clés inutilisées.
Tourner ou révoquer une clé
Ouvrez Paramètres > Développeurs > Clés API et utilisez le menu situé à la fin de la ligne de la clé.
La rotation remplace le secret. Confirmez avec Rotation : le secret actuel cesse immédiatement de fonctionner et le nouveau secret est affiché une seule fois. Mettez à jour votre intégration sans tarder. Une clé expirée ne peut pas être renouvelée ; créez-en une nouvelle.
La révocation désactive définitivement la clé. Confirmez avec Révoquer : les automatisations utilisant la clé cessent immédiatement de fonctionner, et cette action est irréversible.
Dépannage de l'authentification
L'API répond 403 insufficient_scope
insufficient_scopeLa clé est valide, mais elle ne correspond pas à la portée requise par la route. L'en-tête WWW-Authenticate spécifie la portée manquante :
Créez une clé avec cette portée, ou vérifiez que le créateur de la clé possède toujours un rôle qui le lui permet.
WWW-Authenticate: Bearer error="insufficient_scope", scope="sync" L'API répond 403 permission_denied
permission_deniedLa clé possède la portée appropriée, mais l'action n'est pas autorisée sur ce centre d'aide : par exemple, le forfait ne comprend pas cette fonctionnalité ou le centre d'aide est désactivé. Voir Gestion des erreurs, des limites de débit et des nouvelles tentatives de l'API Notiondesk .
Questions fréquentes
Puis-je revoir ma clé API après l'avoir créée ?
Non. Le secret n'est révélé qu'une seule fois, lors de la création ou du changement de la clé. Si vous le perdez, changez la clé et enregistrez le nouveau secret.
Un éditeur peut-il créer une clé API ?
Non. Seuls le propriétaire de l'espace de travail et les administrateurs peuvent créer, renouveler et révoquer les clés API. Un éditeur peut toujours connecter des assistants IA via le panneau d'administration de l'espace de travail .
Les clés API Notiondesk expirent-elles ?
Uniquement si vous définissez une date d'expiration lors de la création de la clé. Les clés créées sans date d'expiration restent valides jusqu'à leur renouvellement ou leur révocation.
Dois-je utiliser une clé API ou OAuth ?
Utilisez une clé API pour l'automatisation de votre propre espace de travail. Utilisez OAuth lorsque d'autres clients connectent votre application à leur espace de travail ; ils pourront ainsi approuver l'accès et le révoquer eux-mêmes.