Legen Sie los mit der Notiondesk REST-API.

Die REST-API Notiondesk ermöglicht es Ihnen, Ihre Hilfezentren mit eigenem Code zu verwalten. Sie können Ihre Hilfezentren auflisten, deren Artikel, Sammlungen und Änderungsprotokolle einsehen, Seitenweiterleitungen verwalten, Einstellungen und Branding ändern, Analysedaten und Leserfeedback abrufen sowie Synchronisierungen von Notion auslösen.

Dieser Artikel erklärt, was die Notiondesk API leisten kann, wer sie nutzen kann und wie Sie in wenigen Minuten Ihre erste Anfrage stellen können.

Was Sie mit der Notiondesk API machen können

Für sofort einsatzbereite Skripte siehe Automatisieren häufiger Aufgaben im Hilfecenter mit der Notiondesk API .

Wer kann die Notiondesk API nutzen?

• Plan: Der API-Zugriff ist in den Enterprise-Plänen enthalten.

• Schlüssel erstellen: Workspace-Besitzer und Administratoren erstellen API-Schlüssel im Dashboard.

• Berechtigungen: Ein Schlüssel oder eine App kann in Ihrem Arbeitsbereich niemals mehr tun, als die Person, die ihn/sie verwendet, tun kann. Siehe Authentifizierung mit der Notiondesk-API mithilfe von API-Schlüsseln .

Stellen Sie Ihre erste Notiondesk API-Anfrage

1. Erstellen Sie einen API-Schlüssel

Öffnen Sie in Ihrem Notiondesk-Dashboard die Einstellungen , dann Entwickler > API-Schlüssel und klicken Sie auf Schlüssel erstellen . Geben Sie ihm eine Bezeichnung, wählen Sie den Lesebereich aus und kopieren Sie den Schlüssel, sobald er angezeigt wird. Der Schlüssel beginnt mit nd_wsk_ und wird nur einmal angezeigt.

Speichern Sie es in einer Umgebungsvariablen:

2. Listen Sie Ihre Hilfezentren auf.

Die Antwort listet alle Hilfezentren in Ihrem Arbeitsbereich auf:

3. Listen Sie die Artikel eines Hilfezentrums auf.

Das war's! Sie lesen Ihr Hilfecenter direkt aus dem Quellcode.

Notiondesk API-Grundlagen

export NOTIONDESK_API_KEY="nd_wsk_..."

curl "<https://api.notiondesk.so/sites>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}

curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Notiondesk API oder Workspace MCP?

Notiondesk bietet zwei Möglichkeiten, Ihre Hilfezentren außerhalb des Dashboards zu betreiben. Sie greifen über unterschiedliche Zugänge auf dieselben Funktionen zu.

Notiondesk API-Endpunkt

Häufig gestellte Fragen

Was kommt als Nächstes?

• Authentifizieren Sie sich mit der Notiondesk API mithilfe der API-Schlüssel.

• Verbinden Sie Ihre App mit Notiondesk über OAuth

• Behandelt API-Fehler, Ratenbegrenzungen und Wiederholungsversuche der Klasse Notiondesk

• Automatisieren Sie häufige Aufgaben im Hilfecenter mit der Notiondesk API