Met de REST API Notiondesk kunt u uw helpcentra beheren met uw eigen code. U kunt uw helpcentra weergeven, hun artikelen, collecties en wijzigingslogboek lezen, paginadirecties beheren, instellingen en branding wijzigen, analyses en feedback van lezers ophalen en synchronisaties vanuit Notion activeren.
Dit artikel legt uit wat de Notiondesk API kan doen, wie hem kan gebruiken en hoe u binnen enkele minuten uw eerste verzoek kunt indienen.
Wat je kunt doen met de Notiondesk API
| Taak | Voorbeeld | Gids |
|---|---|---|
| Lees de helpcentra. | Geef een lijst van alle helpcentra in uw werkruimte en de talen die ze aanbieden. | Lees de helpcentra. |
| Lees de inhoud | Exporteer elk artikel als Markdown, of toon uw wijzigingslogboekvermeldingen. | Lees artikelen, collecties en wijzigingslogboeken. |
| Wijzigingen in Notion publiceren | Synchroniseer je helpcentrum vanuit een CI-pipeline nadat je Notion hebt bewerkt. | Activeer Notion-synchronisaties |
| Omleidingen beheren | Honderden redirects importeren na migratie vanuit een ander helpcentrum | Pagina-omleidingen beheren |
| Taal wijzigen | Voeg een taal toe of schakel automatische vertaling in. | Beheer talen en automatische vertaling |
| Instellingen wijzigen | Update SEO-titels, llms.txt, het contactformulier of het wijzigingslogboek. | Helpcentruminstellingen bijwerken |
| Verander de huisstijl | Pas uw merkkleuren en -thema toe op meerdere helpcentra. | Personaliseer de huisstijl en thema's. |
| Integraties beheren | Configureer Google Analytics, Plausible, Intercom of Crisp. | Integraties beheren |
| Analysegegevens ophalen | Stuur bezoekers, zoekopdrachten en topartikelen naar uw BI-tool. | Bekijk de analyses van het helpcentrum |
| Lees de feedback | Stuur elke ochtend negatieve reacties op artikelen naar Slack. | Lezersfeedback exporteren |
Voor kant-en-klare scripts, zie Veelvoorkomende helpcentrumtaken automatiseren met de Notiondesk API .
Wie kan de Notiondesk API gebruiken?
- Abonnement: API-toegang is inbegrepen in de Enterprise-abonnementen.
- Sleutels aanmaken: Werkruimte-eigenaren en beheerders maken API-sleutels aan in het dashboard.
- Machtigingen: Een sleutel of een app kan nooit meer doen dan de persoon die erachter zit in uw werkruimte. Zie Authentiseren met de Notiondesk API met behulp van API-sleutels .
Doe je eerste Notiondesk API-aanvraag
1. Maak een API-sleutel aan
Open in je Notiondesk dashboard de instellingen , ga vervolgens naar Ontwikkelaars > API-sleutels en klik op Sleutel maken . Geef de sleutel een label, selecteer het leesbereik en kopieer de sleutel wanneer deze wordt weergegeven. De sleutel begint met nd_wsk_ en wordt slechts één keer weergegeven.
Sla het op in een omgevingsvariabele:
2. Geef een lijst van uw helpcentra.
Het antwoord geeft een lijst van alle helpcentra in uw werkruimte:
3. Geef een lijst van de artikelen in een helpcentrum.
Dat is alles! Je leest je helpcentrum nu via code.
Notiondesk API-basisprincipes
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"| Onderwerp | Wat je moet weten |
|---|---|
| Basis-URL | https://api.notiondesk.so |
| Authenticatie | __GEVOORBEHOUDEN_108__. Zie API-sleutels en OAuth |
| Scopes | read, write, sync en admin. Elke route vereist één |
| Versiebeheer | Optionele nd-version header |
| Formaat | JSON-verzoek- en antwoordbody's met veldnamen in snake_case-stijl. |
| Paginering | Cursorgebaseerd: page_size (1 tot 100, standaard 20) en cursor. Zie Paginatie- en versieverzoeken |
| Fouten | Eén JSON-envelop met een machineleesbare code. Zie Fouten afhandelen, snelheidslimieten instellen en herhaalpogingen uitvoeren. |
Notiondesk API of Workspace MCP?
Notiondesk biedt twee manieren om uw helpcentra buiten het dashboard te beheren. Ze bieden via verschillende ingangen toegang tot dezelfde functies.
| Notiondesk REST API | Werkruimte MCP | |
|---|---|---|
| Wie noemt het? | Jouw code: scripts, CI-pipelines, interne tools, partnerapplicaties | Een AI-assistent zoals Claude, ChatGPT, Cursor of VS Code |
| Hoe het inlogt | Een werkruimte-API-sleutel of een OAuth-toegangstoken | OAuth, via uw AI-client |
| Het beste voor | Herhaalbare, deterministische automatisering | Gespreksvoering: "zoek de artikelen die lezers niet waarderen en stel verbeteringen voor" |
Notiondesk API-eindpunt
| Methode | Pad | Domein | Gids |
|---|---|---|---|
GET | /sites | read | Hulpcentra |
GET | /sites/{site_id} | read | Hulpcentra |
GET | /sites/{site_id}/sync-status | read | Hulpcentra |
GET | /sites/{site_id}/articles | read | Inhoud |
GET | /sites/{site_id}/articles/{article_id} | read | Inhoud |
GET | /sites/{site_id}/categories | read | Inhoud |
GET | /sites/{site_id}/categories/{category_id} | read | Inhoud |
GET | /sites/{site_id}/changelog | read | Inhoud |
POST | /sites/{site_id}/sync | sync | Synchronisaties |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Synchronisaties |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Synchronisaties |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Synchronisaties |
GET | /sites/{site_id}/page-redirects | read | Omleidingen |
POST | /sites/{site_id}/page-redirects | write | Omleidingen |
PATCH | /sites/{site_id}/page-redirects/{redirect_id} | write | Omleidingen |
DELETE | /sites/{site_id}/page-redirects/{redirect_id} | admin | Omleidingen |
PATCH | /sites/{site_id}/settings/supported-languages | write | Talen |
PATCH | /sites/{site_id}/settings/auto-translate | write | Talen |
PATCH | /sites/{site_id}/settings/content | write | Instellingen |
PATCH | /sites/{site_id}/settings/ai-optimization | write | Instellingen |
PATCH | /sites/{site_id}/settings/contact-form | write | Instellingen |
PATCH | /sites/{site_id}/settings/changelog | write | Instellingen |
GET | /sites/{site_id}/settings/customize | read | Merkidentiteit |
PATCH | /sites/{site_id}/settings/customize | admin | Merkidentiteit |
GET | /sites/{site_id}/themes | read | Merkidentiteit |
GET | /sites/{site_id}/integrations | read | Integraties |
PATCH | /sites/{site_id}/integrations/{type} | admin | Integraties |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Integraties |
GET | /sites/{site_id}/analytics/{report} | read | Analyses |
GET | /sites/{site_id}/feedback | read | Feedback |
Veelgestelde vragen
Kan ik artikelen aanmaken of bewerken met de Notiondesk API?
Nee. Artikelen, collecties en wijzigingslogboekvermeldingen worden in Notion geschreven en elke synchronisatie overschrijft wat Notiondesk opslaat. Bewerk de Notion-pagina met de Notion-editor of de Notion API en roep vervolgens de synchronisatietrigger aan om de wijziging te publiceren.
Werkt één API-sleutel voor al mijn helpcentra?
Ja. Een API-sleutel voor een werkruimte werkt voor elk helpcentrum in de bijbehorende werkruimte. Elk verzoek bevat de naam van het helpcentrum in het pad, bijvoorbeeld /sites/{site_id}/articles.
Waar vind ik de site_id van een helpcentrum?
site_id van een helpcentrum?Roep GET /sites aan om uw helpcentra met hun id weer te geven. Dit is tevens de identificatiecode na /s/ in de adresbalk van uw dashboard.