In de beheeromgeving kun je zelf API keys aanmaken en beheren. Hieronder lees je wat een API key is, welke mogelijkheden er zijn en hoe je deze gebruikt.
De API key omgeving vind je in beheer > integraties > API keys.
Wat is een API-key?
Een API key is een soort digitale sleutel. Je kunt het vergelijken met de sleutel van je voordeur: alleen met de juiste sleutel(s) krijg je toegang. In dit geval geeft de API key jouw systemen of apps toegang tot gegevens uit je MICE account.
Met een API key kun je dus veilig en automatisch gegevens uitwisselen tussen MICE en andere systemen die je gebruikt.
⚠️ Let op: net als bij een echte sleutel moet je zorgvuldig omgaan met een API sleutel. Als iemand anders jouw API key in handen krijgt, kan diegene ook toegang krijgen tot jouw gegevens of systemen (gegevens lezen, bewerken of verwijderen). Deel een API key daarom nooit met onbekenden.
Functionaliteiten in de API key omgeving
In de API key omgeving kun je verschillende acties uitvoeren:
1. Nieuwe API-key aanmaken
Gebruikers met de rol 'Beheerder' kunnen eenvoudig een nieuwe API key genereren:
Ga naar Beheer > Integraties > API keys.
Klik op de knop + Nieuwe API key.
Geef de key eventueel een herkenbare naam (bijvoorbeeld de naam van de applicatie of integratie).
Bevestig de actie.
💡Tip: Maak per integratie een aparte API-key met een herkenbare naam. Zo houd je overzicht en weet je altijd welke key bij welke integratie hoort en bij welke key bepaalde gegevensuitwisseling hoort.
Overzicht API-keys
In het overzicht vind je alle aangemaakte API-keys terug. Hier zie je:
Datum en tijdstip wanneer een API key is aangemaakt.
Naam van een API key.
Knop voor bekijken API key.
Knop om API opnieuw te genereren.
De status van de API key: Vrijgegeven of Ingetrokken.
2. API-key bekijken en kopiëren
Klik op "bekijk key" om de volledige API key te weergeven.
Om de API key te kopiëren klik je op het klembord icoontje (zie afbeelding hieronder).
3. API-key opnieuw genereren
Is een API key per ongeluk gedeeld of mogelijk onveilig geworden? Dan kun je deze opnieuw genereren:
Open het API key overzicht.
Klik rechts van de betreffende API key op Opnieuw genereren.
De oude key wordt automatisch ongeldig en wordt vervangen door een nieuwe.
4. API-key intrekken of vrijgeven
Gebruik je een API key niet meer of moet deze ongeldig worden gemaakt (bijvoorbeeld bij een gestopte integratie), dan kun je de key intrekken:
Open het API key overzicht.
Klik rechts van de de gewenste API key op Intrekken.
De API key is direct ongeldig. Eventuele gekoppelde integraties verliezen per direct toegang.
E-mail bij nieuwe API-keys
Wanneer iemand in je organisatie een nieuwe API key aanmaakt, ontvangen alle beheerders automatisch een email. Zo blijven beheerders op de hoogte van nieuwe integraties en kun je direct actie ondernemen als dat nodig is.
Voorbeeld email:
Tips
Maak aparte keys per integratie: Zo houd je overzicht en kun je makkelijker intrekken waar nodig.
Beperk toegang: Trek ongebruikte of ongewenste API keys direct in.
Controleer regelmatig: Houd het overzicht in de gaten en let op ongebruikelijke aanmaakmomenten.
Let op met delen: Deel een API key nooit via onbeveiligde kanalen en met onbekende personen en emailadressen.
API-key historie: wie heeft wat gedaan?
Naast het aanmaken, opnieuw genereren, intrekken of vrijgeven van API-keys, biedt de beheeromgeving binnen MICE Operations ook inzicht in wie welke handelingen heeft uitgevoerd in de API-key omgeving.
In de omgeving Beheer > Historie is een historie/log beschikbaar die toont: wanneer een API-key is aangemaakt, ingezien, gewijzigd of ingetrokken, en door welke gebruiker. Zo kun je eenvoudig controleren wie met welke sleutel een actie heeft uitgevoerd.
💡Tip: Selecteer bij de historie het object "API Key" zodat je een overzicht hebt met alle handelingen omtrent API keys.
