Authenticeer bij de Notiondesk API met behulp van API-sleutels.

Elke API-aanvraag voor Notiondesk wordt geverifieerd met een bearer-token: een workspace API-sleutel of een OAuth-toegangstoken voor apps die namens andere Notiondesk-klanten handelen. Dit artikel laat zien hoe u een Notiondesk API-sleutel aanmaakt, de scopes ervan kiest, deze met uw aanvragen meestuurt en deze wijzigt of intrekt.

Gebruik een API-sleutel voor automatisering die u uitvoert voor uw eigen werkruimte: een script, een geplande taak, een CI-stap of een interne tool. Als u een app bouwt waarmee andere Notiondesk-klanten verbinding maken, gebruik dan OAuth .

Voordat je begint

• Uw werkplek maakt gebruik van een Enterprise-abonnement.

• U bent de eigenaar van de werkruimte of een beheerder.

Maak een Notiondesk API-sleutel aan

1. Klik in je Notiondesk dashboard op Instellingen .

2. Ga naar Werkruimte , open Ontwikkelaars en vervolgens API-sleutels .

3. Klik op Sleutel aanmaken .

4. Voer een label in dat aangeeft waar de sleutel voor dient, bijvoorbeeld CI automation of Redirect import.

5. Selecteer onder Bereiken alleen de bereiken die de integratie nodig heeft. Zie De juiste bereiken kiezen .

6. Kies een vervaldatum : 30 dagen , 90 dagen , 1 jaar of geen vervaldatum .

7. Klik op 'Maken' .

8. Klik op 'Sleutel kopiëren' en sla de sleutel op in uw geheimenbeheerder of omgevingsvariabelen.

9. Klik op ' Ik heb de sleutel opgeslagen' .

De sleutel wordt slechts één keer getoond. Als je hem kwijtraakt, draai de sleutel dan om een ​​nieuw geheim te krijgen.

Let op: als er bij 'Sleutel aanmaken' een slotje staat en de tooltip 'Beschikbaar op abonnementen met API-toegang.', dan is de API niet inbegrepen in uw abonnement. Door erop te klikken, worden de upgrade-opties geopend.

Kies de juiste richtkijkers.

Een scope is een machtiging die aan een sleutel is gekoppeld. Elke API-route vereist één scope, en een sleutel kan er meerdere bevatten.

Geef elke integratie de kleinste set scopes die deze nodig heeft:

Hoe de rollen op de werkplek een belangrijke factor beperken

Een sleutel kan nooit meer dan de persoon die hem heeft gemaakt in jouw werkomgeving kan doen.

Als de rol van de maker verandert, verandert ook het effectieve bereik van de sleutel. Als de maker de werkruimte verlaat, werkt de sleutel niet meer. Beheer rollen in Hoe een teamlid uit te nodigen .

Stuur de sleutel mee met elk verzoek.

Verzend de sleutel in de Authorization-header met het Bearer-schema:

Een 200 OK met een lijst van uw helpcentra bevestigt dat de sleutel werkt. Eén sleutel werkt voor elk helpcentrum in de bijbehorende werkruimte.

Hetzelfde verzoek in JavaScript:

En in Python:

Bewaar uw Notiondesk API-sleutel veilig.

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

const response = await fetch("<https://api.notiondesk.so/sites>", {
  headers: {
    Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
    "nd-version": "2026-10-16",
  },
});

const sites = await response.json();

import os
import requests

response = requests.get(
    "<https://api.notiondesk.so/sites>",
    headers={
        "Authorization": f"Bearer {os.environ['NOTIONDESK_API_KEY']}",
        "nd-version": "2026-10-16",
    },
)
sites = response.json()

• Bewaar de sleutels op uw server. Plaats een sleutel nooit in browsercode, een mobiele app of een openbare repository.

• Bewaar sleutels in omgevingsvariabelen of een geheimbeheerder, niet in de broncode.

• Maak per integratie één sleutel aan met een eigen label, zodat u er één kunt intrekken zonder de andere te beschadigen.

• Kies een vervaldatum voor sleutels die door tijdelijke scripts worden gebruikt.

• Geef een sleutel door wanneer iemand die ermee vertrouwd was, je team verlaat.

• Controleer de kolom 'Laatst gebruikt' en trek sleutels in die niemand gebruikt.

Een sleutel draaien of intrekken

Open Instellingen > Ontwikkelaars > API-sleutels en gebruik het menu aan het einde van de rij van de sleutel.

Met Rotate wordt het geheim vervangen. Bevestig met Rotate : het huidige geheim werkt direct niet meer en het nieuwe geheim wordt eenmalig weergegeven. Werk uw integratie direct bij. Een verlopen sleutel kan niet worden geroteerd; maak in plaats daarvan een vervangende sleutel aan.

Met 'Revoke' wordt de sleutel definitief uitgeschakeld. Bevestig met 'Revoke' : automatiseringen die de sleutel gebruiken, werken dan onmiddellijk niet meer en dit kan niet ongedaan worden gemaakt.

Problemen met authenticatie oplossen

WWW-Authenticate: Bearer error="insufficient_scope", scope="sync"

Veelgestelde vragen

Wat volgt?

• Ga aan de slag met de Notiondesk REST API

• Verbind je app met Notiondesk via OAuth.

• Verwerk API-fouten, snelheidslimieten en herhaalpogingen voor Notiondesk.