api
Ga aan de slag met de Notiondesk REST APIGebruik de REST API Notiondesk om de inhoud van het helpcentrum te lezen, omleidingen en instellingen te beheren, analyses op te halen en Notion-synchronisaties vanuit code te starten.
Authenticeer bij de Notiondesk API met behulp van API-sleutels.Maak een Notiondesk API-sleutel aan, kies lees-, schrijf-, synchronisatie- of beheerdersrechten en authenticeer REST API-verzoeken met een bearer-token. De sleutel kan op elk gewenst moment worden geroteerd of ingetrokken.
Verbind je app met Notiondesk via OAuth.Bouw een Notiondesk OAuth-app: registreer een client, voer de OAuth 2.0-autorisatiecodeflow uit met PKCE, vernieuw tokens en roep de REST API aan.
Paginatie en versie Notiondesk API-verzoekenBlader door API-lijsten van Notiondesk met page_size en cursor, zet een versie vast met de nd-version-header en gebruik snake_case voor veldnamen.
Verwerk API-fouten, snelheidslimieten en herhaalpogingen voor Notiondesk.Notiondesk API-foutcodes en envelop, snelheidslimieten van 120 lees- en 20 schrijfbewerkingen per minuut, Retry-After en veilige herhaalpogingen met Idempotency-Key.
Lees de helpcentra met de Notiondesk APIBekijk een lijst van uw Notiondesk helpcentra, lees hun domein, talen en instellingen en controleer de status van geplande Notion-synchronisaties met de Notiondesk API.
Lees artikelen, collecties en wijzigingslogboeken met de Notiondesk APILees artikelen en collecties uit het helpcentrum van Notiondesk als markdown, in elke taal, met synchronisatiestatus, en bekijk wijzigingslogboekvermeldingen via de REST API.
Trigger Notion synchroniseert met de Notiondesk APISynchroniseer uw Notiondesk helpcentrum vanuit Notion via de API: start een synchronisatie van een site, collectie of artikel en schakel geplande synchronisatie in of uit.
Beheer pagina-omleidingen met de Notiondesk APIOmleidingen naar de helpcentrumpagina Notiondesk maken, weergeven, bijwerken en verwijderen via de REST API. Oude URL's in bulk importeren na een migratie.
Beheer talen en automatische vertaling met de Notiondesk APIVoeg talen toe aan of verwijder talen uit het helpcentrum, stel de standaardtaal in en schakel de automatische AI-vertaling Notiondesk in of uit via de REST API.
Update de instellingen van het helpcentrum met de Notiondesk APIUpdate de instellingen van het helpcentrum via de REST API: SEO-indexering, paginatitels, llms.txt- en markdown-export, het contactformulier en wijzigingslogboeken.
Personaliseer de huisstijl en thema's van het helpcentrum met de Notiondesk APIUpdate de huisstijl van het helpcentrum via de REST API: kleuren, lettertypen, lay-out, links in de kop- en voettekst, weergave van zoekresultaten en thema's.
Beheer integraties met het helpcentrum via de Notiondesk APIConfigureer Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout en Google Tag Manager in uw Notiondesk helpcentrum via de REST API.
Krijg inzicht in de resultaten van het helpcentrum met de Notiondesk API.Exporteer Notiondesk helpcentrumanalyses via de REST API: bezoekers, artikelweergaven, meest gezochte termen, zoekopdrachten zonder resultaten en reacties van lezers.
Exporteer lezersfeedback met de Notiondesk APIExporteer feedback op het artikel Notiondesk via de REST API: reacties van lezers, vervolgantwoorden, berichten en bijlagen, met de nieuwste eerst.
Automatiseer veelvoorkomende helpcentrumtaken met de Notiondesk APINotiondesk API-voorbeelden: synchroniseren vanuit GitHub Actions, artikelen back-uppen als markdown, feedback plaatsen op Slack en zoekopdrachten zonder resultaten rapporteren.