developer
Legen Sie los mit der Notiondesk REST-API.Verwenden Sie die Notiondesk REST-API, um Hilfecenter-Inhalte zu lesen, Weiterleitungen und Einstellungen zu verwalten, Analysen abzurufen und Notion-Synchronisierungen aus dem Code heraus auszulösen.
Authentifizieren Sie sich mit der Notiondesk API mithilfe der API-Schlüssel.Erstellen Sie einen Notiondesk API-Schlüssel, wählen Sie Lese-, Schreib-, Synchronisierungs- oder Administratorrechte und authentifizieren Sie REST-API-Anfragen mit einem Bearer-Token. Sie können den Schlüssel jederzeit ändern oder widerrufen.
Verbinden Sie Ihre App mit Notiondesk über OAuthErstellen Sie eine Notiondesk OAuth-App: Registrieren Sie einen Client, führen Sie den OAuth 2.0 Autorisierungscode-Flow mit PKCE und Aktualisierungstoken aus und rufen Sie die REST-API auf.
Paginierung und Versions-API-Anfragen NotiondeskDurchblättern Sie die API-Listen Notiondesk mit page_size und cursor, fixieren Sie eine Version mit dem nd-version-Header und verwenden Sie snake_case-Feldnamen.
Behandelt API-Fehler, Ratenbegrenzungen und Wiederholungsversuche der Klasse NotiondeskNotiondesk API-Fehlercodes und Envelope, Ratenbegrenzungen von 120 Lesevorgängen und 20 Schreibvorgängen pro Minute, Retry-After und sichere Wiederholungsversuche mit Idempotency-Key.
Lesen Sie Ihre Hilfezentren mit der Notiondesk API.Listen Sie Ihre Notiondesk-Hilfezentren auf, lesen Sie deren Domäne, Sprachen und Einstellungen und überprüfen Sie den geplanten Notion-Synchronisierungsstatus mit der Notiondesk-API.
Lesen Sie Artikel, Sammlungen und Änderungsprotokolleinträge mit der Notiondesk API.Lesen Sie Hilfeartikel und Sammlungen des Notiondesk als Markdown in jeder Sprache mit synchronisiertem Status und listen Sie Änderungsprotokolleinträge über die REST-API auf.
Trigger Notion synchronisiert sich mit der Notiondesk APISynchronisieren Sie Ihr Notiondesk Hilfecenter von Notion über die API: Lösen Sie eine Website-, Sammlungs- oder Artikelsynchronisierung aus und schalten Sie die geplante Synchronisierung ein oder aus.
Seitenweiterleitungen mit der Notiondesk API verwaltenErstellen, auflisten, aktualisieren und löschen Sie Weiterleitungen der Hilfeseite Notiondesk über die REST-API. Importieren Sie alte URLs nach einer Migration per Massenimport.
Sprachen und automatische Übersetzung mit der Notiondesk API verwalten.Hilfezentrumssprachen hinzufügen oder entfernen, die Standardsprache festlegen und die automatische KI-Übersetzung über die REST-API ein- oder ausschalten.
Aktualisieren Sie die Einstellungen des Hilfecenters mit der Notiondesk APIAktualisieren Sie die Einstellungen des Hilfecenters Notiondesk über die REST-API: SEO-Indexierung, Seitentitel, llms.txt- und Markdown-Export, das Kontaktformular und Änderungsprotokolle.
Passen Sie das Branding und die Designs Ihres Hilfecenters mit der Notiondesk API an.Aktualisieren Sie das Branding des Hilfecenters über die REST-API: Farben, Schriftarten, Layout, Kopf- und Fußzeilenlinks, Suchanzeige und Designs.
Verwalten Sie Help-Center-Integrationen mit der Notiondesk APIKonfigurieren Sie Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout und Google Tag Manager auf Ihrem Notiondesk Hilfezentrum über die REST-API.
Erhalten Sie Hilfecenter-Analysen mit der Notiondesk APIExportieren Sie die Analysedaten des Hilfecenters über die REST-API: Besucher, Artikelaufrufe, Top-Suchanfragen, Suchanfragen ohne Ergebnisse und Leserreaktionen.
Exportieren Sie Leserfeedback mit der Notiondesk APIExportieren Sie Feedback zum Artikel Notiondesk über die REST-API: Leserreaktionen, Folgeantworten, Nachrichten und Anhänge, neueste zuerst.
Automatisieren Sie häufige Aufgaben im Hilfecenter mit der Notiondesk APINotiondesk API-Beispiele: Synchronisierung von GitHub Actions, Sicherung von Artikeln als Markdown, Veröffentlichung von Feedback in Slack und Meldung von Suchanfragen ohne Ergebnisse.