API -sleutels beheren

Een API-sleutel is een unieke ID die wordt gebruikt voor verificatie van een gebruiker, ontwikkelaar of een aanroepend programma voor een API. API-sleutels worden vaak gebruikt om het gebruik van de interface bij te houden en te beheren en misbruik van de API te voorkomen.

Overzicht API-sleutels

De API-sleutels zijn in de Beheerconsole standaard uitgeschakeld. Als u de API-sleutels wilt inschakelen, gaat u naar de sectie Instellingen. Een tenantbeheerder kan API-sleutels intrekken en de API-sleutelinstellingen bewerken, maar om API-sleutels te genereren of te verwijderen moet u de rol ontwikkelaar hebben. Een tenantbeheerder wijst de rol ontwikkelaar toe aan een gebruiker. Als u een tenantbeheerder bent, kunt u de rol ontwikkelaar aan uzelf toewijzen.

De tabel met API-sleutels bevat de volgende informatie over de API-sleutels: naam, ID, eigenaar, laatste update, aanmaakdatum, vervaldatum en status. Gebruik het zoekveld om te zoeken in de eerste drie velden: Key name, Key ID en Owner.

API-sleutelstatussen

API-sleutels kunnen de volgende statussen hebben:

Actief: de API-sleutel is in gebruik.
Vervallen: de vervaldatum is bereikt.
Ingetrokken: de API-sleutel is ingetrokken en kan niet langer worden gebruikt.

Als beheerder kunt u de API-sleutelactiviteiten controleren die in de sectie Gebeurtenissen van de Beheerconsole zijn geregistreerd. Als u verdachte activiteiten detecteert, zoals overmatig gebruik van een bepaalde API-sleutel, kunt u die API-sleutel intrekken. Open de gedetailleerde lijst door op de pijl helemaal rechts in de tabel te klikken en de ID van de API-sleutel te kopiëren. Vervolgens zoekt u de ID op in de secties API-sleutels om de in te trekken API-sleutel te vinden.

Als u een enkele API-sleutel wilt intrekken, klikt u op de knop ... uiterst rechts en selecteert u Intrekken. U kunt alleen sleutels intrekken die status Actief hebben. Als u meerdere sleutels wilt intrekken, vinkt u de selectievakjes links naast de in te trekken sleutel aan en klikt u op Intrekken in de rechterbovenhoek. Intrekken kan niet ongedaan worden gemaakt; een ingetrokken API-sleutel kan niet opnieuw worden geactiveerd.

U kunt sleutels niet alleen intrekken maar ook verwijderen. U kunt een API-sleutel verwijderen uit de hub, maar niet uit de Beheerconsole.

API-sleutels inschakelen in de tenant

De instelling API-sleutels inschakelen wordt geactiveerd op de pagina Instellingen in de Beheerconsole. De API-sleutels zijn in de Beheerconsole standaard uitgeschakeld.

Eigenschappen voor API-sleutels
Eigenschap	Beschrijving
API-sleutels inschakelen	Met deze schakelaar worden alle API-sleutels in de tenant ingeschakeld of uitgeschakeld. Alleen de tenantbeheerder kan de API‑sleutels inschakelen.
Maximale vervaldatum van token wijzigen	Door de vervalwaarde van het token te wijzigen, wordt de nieuwe vervalwaarde op alle nieuwe tokens toegepast. Deze wijziging heeft geen invloed op bestaande API's, deze behouden dezelfde vervalwaarde als hiervoor. Er is geen maximumlimiet voor de waarde.
Maximale aantal API‑sleutels per gebruiker wijzigen	Deze instelling is alleen van invloed op nieuwe API‑sleutels. Als door een nieuwe API-sleutel het totale aantal het maximale aantal overschrijdt, wordt het maken ervan geweigerd. Het maximumlimiet van de waarde is 1000.

Doe het volgende:

Ga in de Beheerconsole naar de pagina Instellingen.
Schakel onder de sectie API-sleutels de knop API-sleutels inschakelen aan.
Wijzig indien van toepassing de instellingen Maximale vervaldatum van token wijzigen en Maximumaantal API-sleutels per gebruiker wijzigen.

Een API-sleutel genereren vanuit de hub

U kunt API-sleutels genereren vanuit de hub. Controleer voordat u begint of aan de volgende drie vereisten is voldaan:

U gebruikt een licentie. Een licentie is vereist om een API-sleutel te genereren.
De instelling Inschakelen voor API-sleutels is ingeschakeld in de Beheerconsole.
De tenantbeheerder heeft de rol ontwikkelaar aan u toegewezen.

Doe het volgende:

Meld u aan bij uw tenant, bijvoorbeeld https://<tenantnaam>.com.
Klik rechtsboven op uw profiel en selecteer Profielinstellingen.
Selecteer API-sleutels.
Klik op Nieuwe sleutel genereren.
Voer een beschrijving in voor de API-sleutel en selecteer wanneer de API-sleutel moet verlopen.
Klik op Genereren.

Een API-sleutel wordt gegenereerd.
Kopieer de API-sleutel en bewaar deze kopie op een veilige plek.

Nadat u de API -sleutel heeft gemaakt, kunt u de naam ervan wijzigen. U kunt de sleutel ook verwijderen.

Was deze pagina nuttig?

Als u problemen ervaart op deze pagina of de inhoud onjuist is – een typfout, een ontbrekende stap of een technische fout – laat het ons weten zodat we dit kunnen verbeteren!

Geef hier uw feedback