Veelgestelde Vragen

Wat is de Public API?

Public API

De TechUitgelegd Public API biedt programmatische toegang tot uw portaalgegevens. Hiermee kunt u:

Tickets automatisch uitlezen en aanmaken vanuit uw eigen systemen
Abonnementen en urenbundels monitoren
Gebruikersgegevens ophalen voor integraties

Wie kan de API gebruiken?

De API is beschikbaar voor KlantBeheerders waarvan de organisatie API-toegang heeft geactiveerd. Neem contact op met TechUitgelegd als u API-toegang wilt activeren.

Hoe begin ik?

Ga naar API Keys om een key aan te maken
Bekijk de API Documentatie voor alle beschikbare endpoints
Gebruik de key in de X-API-Key header bij elk verzoek

Hoe maak ik een API key aan?

API Key aanmaken

Ga naar API Keys beheer
Vul een herkenbare naam in (bijv. "Monitoring server" of "Dashboard integratie")
Selecteer de gewenste rechten (permissions) — geef alleen de rechten die nodig zijn
Kies een geldigheidsduur (30 dagen, 90 dagen, 1 jaar, of geen verloop)
Klik op Aanmaken

Belangrijk: De API key wordt slechts eenmaal getoond! Kopieer de key direct na het aanmaken en bewaar deze veilig. De key kan niet meer worden opgevraagd.

Veiligheid

Deel uw API key nooit met derden
Sla de key niet op in broncode of openbare plekken
Gebruik omgevingsvariabelen of een secrets manager
Maak voor elke integratie een aparte key aan
Trek oude keys in wanneer ze niet meer nodig zijn

Welke API rechten (permissions) zijn er?

API Permissions

Bij het aanmaken van een API key kiest u welke rechten de key heeft. Gebruik het principe van least privilege: geef alleen de rechten die uw integratie daadwerkelijk nodig heeft.

Recht	Wat kan de key?
`tickets:read`	Tickets ophalen en details bekijken
`tickets:write`	Nieuwe tickets aanmaken namens uw organisatie
`subscriptions:read`	Abonnementen inzien
`urenbundels:read`	Urenbundels met verbruik inzien
`urenregistraties:read`	Individuele urenregistraties ophalen
`users:read`	Gebruikerslijst van uw organisatie ophalen

Een verzoek naar een endpoint waarvoor de key geen recht heeft, resulteert in een 403 Forbidden response.

API Rate limiting en foutafhandeling

Rate Limiting

Elke API key heeft een limiet van 60 verzoeken per minuut. Bij overschrijding ontvangt u:

HTTP 429 Too Many Requests
{"error": "Rate limit exceeded", "retryAfterSeconds": 60}

Wacht minimaal 60 seconden voordat u opnieuw probeert.

Veelvoorkomende foutcodes

Code	Betekenis	Oplossing
`401`	Niet geauthenticeerd	Controleer of de X-API-Key header correct is
`403`	Geen toestemming	De key mist het benodigde recht voor dit endpoint
`404`	Niet gevonden	Het gevraagde item bestaat niet of behoort niet tot uw klant
`429`	Rate limit bereikt	Wacht 60 seconden en probeer opnieuw

Tips

Implementeer exponential backoff bij 429 responses
Cache responses waar mogelijk om het aantal verzoeken te beperken
Gebruik pagination (page en pageSize parameters) voor grote datasets

Mijn API key verloopt, wat nu?

API Key verlengen

API keys kunnen niet worden verlengd. Wanneer een key verloopt, moet u een nieuwe aanmaken:

Ga naar API Keys beheer
Maak een nieuwe key aan met dezelfde rechten
Werk uw integratie(s) bij met de nieuwe key
Trek optioneel de oude key in

Wanneer ontvang ik een waarschuwing?

U ontvangt automatisch een e-mail:

7 dagen voor het verlopen van de key
1 dag voor het verlopen (urgente herinnering)

Wat gebeurt er als de key verloopt?

Alle API-verzoeken met de verlopen key worden geweigerd met een 401 Unauthorized response. Uw integraties stoppen met werken totdat u een nieuwe key configureert.

Categorieën