Référence API

Chaque point de terminaison de l'API Notiondesk avec ses paramètres, ses réponses et des exemples de code.

L'API REST Notiondesk vous permet de gérer vos centres d'aide directement dans le code. Accédez aux articles, collections et journaux de modifications, gérez les redirections de pages, mettez à jour les paramètres, la personnalisation et les intégrations, exportez les analyses et les commentaires des lecteurs, et déclenchez des synchronisations depuis Notion. Vous continuez à rédiger votre contenu dans Notion : l'API le lit et le synchronise, sans le modifier.

URL de base

Envoyez toutes les requêtes à https://api.notiondesk.so. Les chemins des points de terminaison commencent par /sites, et les requêtes et les réponses utilisent le format JSON.

Authentification

Chaque requête contient un jeton porteur dans l'en-tête Authorization :

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Clé API : pour vos scripts, tâches planifiées et intégration continue. Le propriétaire de l’espace de travail ou un administrateur la crée dans Paramètres > Développeurs > Clés API. Les clés commencent par nd_wsk_ et fonctionnent pour tous les centres d’aide de l’espace de travail. Consultez la section « S’authentifier auprès de l’API Notiondesk à l’aide de clés API » .

Chaque point de terminaison nécessite une étendue : read, write, sync ou admin. La page de chaque point de terminaison indique laquelle.

Exemples de code

Chaque page de point de terminaison répertorie ses paramètres, le corps de la requête et les réponses, avec des exemples de code prêts à copier en cURL, JavaScript et Python.

Guides

  • Guides de démarrage : clés API, OAuth, pagination et versions, erreurs et limites de débit, et exemples.
  • Webhooks : recevez une requête sur votre serveur lorsqu'un événement se produit dans Notiondesk.