API-referentie

Elk Notiondesk API-eindpunt met zijn parameters, reacties en codevoorbeelden.

Met de REST API Notiondesk kunt u uw helpcentra vanuit code beheren. Lees artikelen, collecties en wijzigingslogboeken, beheer paginadirecties, update instellingen, branding en integraties, exporteer analyses en feedback van lezers en activeer synchronisaties vanuit Notion. U schrijft uw content nog steeds in Notion: de API leest en synchroniseert deze, maar bewerkt deze niet.

Basis-URL

Stuur elk verzoek naar https://api.notiondesk.so. Eindpuntpaden beginnen met /sites, en verzoeken en antwoorden gebruiken JSON.

Authenticatie

Elk verzoek bevat een bearer-token in de Authorization-header:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • API-sleutel : voor uw eigen scripts, geplande taken en CI. De eigenaar van de werkruimte of een beheerder maakt deze aan in Instellingen > Ontwikkelaars > API-sleutels. Sleutels beginnen met nd_wsk_ en werken voor elk helpcentrum in de werkruimte. Zie Authentiseren met de Notiondesk API met behulp van API-sleutels .

Elk eindpunt heeft één bereik nodig: read, write, sync of admin. Op de pagina van elk eindpunt staat aangegeven welk bereik van toepassing is.

Codevoorbeelden

Op elke endpointpagina worden de parameters, de request body en de responses weergegeven, met kant-en-klare codevoorbeelden in cURL, JavaScript en Python.

Gidsen

  • Webhooks : ontvang een verzoek op uw server wanneer er iets gebeurt in Notiondesk.