API-tokens en webhooks

Aangemaakte API-tokens beheren

Beheerders kunnen alle API-tokens bekijken en beheren die binnen hun school zijn aangemaakt. Voorheen was een API-token alleen zichtbaar voor de medewerker die het token had aangemaakt. Het overzicht Uitgegeven tokens biedt beheerders nu een centrale plek om deze tokens te beheren.

Volg de onderstaande stappen om de aangemaakte API-tokens te bekijken.

1. Klik op je Schoolnaam. 
2. Klik op settings Instellingen in het menu bovenaan.
3. Klik op API in het menu aan de linkerkant.
4. Klik onder API-tokens op Uitgegeven tokens. Het weergegeven aantal geeft aan hoeveel API-tokens binnen je school zijn aangemaakt.

Het overzicht toont de volgende informatie voor elk token:

• Naam – De naam van het API-token.
• Aangemaakt door – De medewerker die het token heeft aangemaakt.
• IP-beperking – De IP-beperking die voor het token is ingesteld.
• Aangemaakt op – Wanneer het token is aangemaakt.
• Laatst gebruikt – Wanneer het token voor het laatst is gebruikt.
• Status – De huidige status van het token.

Je kunt het filter gebruiken om tokens te zoeken op naam of op de naam van de medewerker die ze heeft aangemaakt. Je kunt het overzicht ook filteren om alleen Actieve of Inactieve tokens weer te geven.

Volg de onderstaande stappen om een API-token in te trekken.

1. Ga naar Uitgegeven tokens.
2. Zoek het API-token dat je wilt intrekken.
3. Klik op het more_horiz -icoon naast het token.
4. Klik op Intrekken.

error_outline Wanneer je een API-token intrekt, kan het onmiddellijk niet meer worden gebruikt. Deze actie kan niet ongedaan worden gemaakt.

Het aanmaken van API-tokens instellen

Scholen met het Campus-abonnement kunnen instellen of medewerkers API-tokens mogen aanmaken zonder goedkeuring. Deze instelling bepaalt of een nieuw aangemaakt token direct actief wordt of eerst moet worden goedgekeurd door een beheerder.

Volg de onderstaande stappen om het aanmaken van API-tokens in te stellen.

1. Klik op je Schoolnaam. 
2. Klik op settings Instellingen in het menu bovenaan.
3. Klik op API in het menu aan de linkerkant.
4. Kies naast API-tokens aanmaken een van de volgende opties:
   • Elke medewerker
     Medewerkers kunnen API-tokens aanmaken die direct actief worden.
   • Alleen na goedkeuring
     Medewerkers kunnen API-tokens aanmaken, maar een beheerder moet deze goedkeuren voordat ze kunnen worden gebruikt.

Wanneer Alleen na goedkeuring is geselecteerd, blijven nieuw aangemaakte tokens inactief totdat ze zijn goedgekeurd. Medewerkers zien de status Wacht op goedkeuring op hun pagina met persoonlijke instellingen.

Beheerders kunnen deze tokens herkennen aan de status Goedkeuring vereist in het overzicht met uitgegeven tokens van de school. Zolang er minimaal één token op goedkeuring wacht, is ook het statusfilter Goedkeuring vereist beschikbaar.

Volg de onderstaande stappen om een API-token goed te keuren.

1. Ga naar je schoolinstellingen.
2. Klik op API.
3. Klik op Uitgegeven tokens.
4. Zoek het token met de status Goedkeuring vereist.
5. Klik op het more_horiz -icoon naast het token.
6. Klik op Goedkeuren.

Na goedkeuring kan het API-token worden gebruikt.

Voor scholen zonder het Campus-abonnement toont de instelling API-tokens aanmaken een link naar de prijzenpagina. API-tokens die door medewerkers van deze scholen worden aangemaakt, worden direct actief en hoeven niet te worden goedgekeurd.

Schoolbrede webhooks aanmaken

Beheerders kunnen webhooks aanmaken die gekoppeld zijn aan de school in plaats van aan een individuele medewerker. Schoolbrede webhooks ontvangen gebeurtenissen uit de hele school, ongeacht welke medewerker de gebeurtenis heeft veroorzaakt.

In tegenstelling tot persoonlijke webhooks zijn schoolbrede webhooks niet afhankelijk van de toegangsrechten van een individuele medewerker. Hierdoor blijven ze werken wanneer een medewerker geen toegang meer heeft tot een vak of de school verlaat.

Een school kan maximaal tien schoolbrede webhooks aanmaken. Deze limiet staat los van de persoonlijke webhooks die door individuele medewerkers worden aangemaakt.

Volg de onderstaande stappen om een schoolbrede webhook aan te maken.

1. Klik op je Schoolnaam. 
2. Klik op settings Instellingen in het menu bovenaan.
3. Klik op API in het menu aan de linkerkant.
4. Ga naar de sectie voor schoolbrede webhooks.
5. Klik + Nieuwe webhook.
6. Voer de Endpoint-URL in.
7. Specificeer de Abonnementen voor de gebeurtenissen die je wilt ontvangen.
8. Selecteer de API versie.
9. Klik Aanmaken.

Elke schoolbrede webhook heeft een eigen ondertekeningssleutel en gebeurtenissenlogboek. Je kunt de ondertekeningssleutel gebruiken om de authenticiteit van webhookberichten te verifiëren. In het gebeurtenissenlogboek kun je individuele gebeurtenissen bekijken en indien nodig opnieuw laten versturen.

Volg de onderstaande stappen om een gebeurtenis opnieuw te versturen.

1. Ga naar je schoolinstellingen.
2. Klik op API.
3. Klik op de webhook.
4. Klik op het replay -icoon naast het event. 
5. Klik Bevestigen.