API-Referenz

Jeder Notiondesk API-Endpunkt mit seinen Parametern, Antworten und Codebeispielen.

Mit der REST-API Notiondesk können Sie Ihre Hilfezentren direkt im Code steuern. Lesen Sie Artikel, Sammlungen und Änderungsprotokolleinträge, verwalten Sie Seitenweiterleitungen, aktualisieren Sie Einstellungen, Branding und Integrationen, exportieren Sie Analysen und Leserfeedback und lösen Sie Synchronisierungen direkt in Notion aus. Sie erstellen Ihre Inhalte weiterhin in Notion: Die API liest und synchronisiert sie, bearbeitet sie aber nicht.

Basis-URL

Sende jede Anfrage an https://api.notiondesk.so. Endpunktpfade beginnen mit /sites, und Anfragen und Antworten verwenden JSON.

Authentifizierung

Jede Anfrage enthält ein Bearer-Token im Authorization-Header:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"

Jeder Endpunkt benötigt einen Gültigkeitsbereich: read, write, sync oder admin. Welcher Bereich zutrifft, wird auf der jeweiligen Endpunktseite angezeigt.

Codebeispiele

Auf jeder Endpunktseite werden die Parameter, der Anfragetext und die Antworten aufgelistet, zusammen mit sofort kopierbaren Codebeispielen in cURL, JavaScript und Python.

Leitfäden

  • Webhooks : Erhalten Sie eine Anfrage auf Ihrem Server, wenn etwas in Notiondesk passiert.