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"- API-Schlüssel : Für Ihre eigenen Skripte, geplanten Jobs und CI. Der Workspace-Inhaber oder ein Administrator erstellt ihn unter Einstellungen > Entwickler > API-Schlüssel. Schlüssel beginnen mit
nd_wsk_und funktionieren für jedes Hilfezentrum im Workspace. Siehe Authentifizierung mit der Notiondesk API mithilfe von API-Schlüsseln .
- OAuth-Zugriffstoken : für Apps, mit denen andere Notiondesk-Kunden eine Verbindung herstellen. Siehe Verbinden Sie Ihre App mit Notiondesk über OAuth .
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
- Erste Schritte mit der Notiondesk REST-API : Ihre erste Anfrage, Schritt für Schritt.
- Leitfäden für den Einstieg : API-Schlüssel, OAuth, Paginierung und Versionen, Fehler und Ratenbegrenzungen sowie Beispiele.
- Webhooks : Erhalten Sie eine Anfrage auf Ihrem Server, wenn etwas in Notiondesk passiert.