API -sleutels beheren
API-sleutels dienen als unieke id's voor authenticatie, zodat gebruikers, ontwikkelaars of programma's veilig toegang krijgen tot een API. API-sleutels worden vaak gebruikt om het gebruik van API bij te houden en te beheren om misbruik te voorkomen.
Overzicht API-sleutels
In de sectie API-sleutels van het Beheer-activiteitencentrum, kunt u alle API-sleutels bekijken die zijn gekoppeld met uw tenant. U kunt op basis van naam, id of eigenaar zoeken naar sleutels.
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.
Tenantbeheerders kunnen het genereren van API-sleutels inschakelen en API-sleutels bewaken en intrekken. De rol Developer is vereist om API-sleutels te genereren, bewerken of verwijderen. Tenantbeheerders kunnen deze rol toewijzen aan gebruikers en aan zichzelf.
API-sleutels inschakelen in de tenant
De API-sleutels zijn standaard uitgeschakeld. Tenantbeheerders kunnen API-sleutels binnen de tenant inschakelen.
Doe het volgende:
- In het Beheer-activiteitencentrum gaat u naar Instellingen.
- Ga naar de sectie API-sleutels en selecteer API-sleutels inschakelen.
- Pas indien nodig de volgende instellingen aan:
Maximale vervaldatum van token wijzigen: wijzigt de verloopdatum van nieuw gegenereerde tokens. Bestaande API-sleutels behouden hun originele verloopwaarde. Er is geen maximumlimiet voor deze waarde.
InformatieU moet mogelijk uw browser vernieuwen om de wijzigingen van deze waarde te zien in de sectie API-sleutels op de pagina van uw gebruikersprofiel.- Maximale aantal actieve API-sleutels per gebruiker wijzigen: deze instelling is alleen van invloed op nieuwe API-sleutels. Als de limiet is bereikt, is het maken van nieuwe API-sleutels niet mogelijk. De maximumwaarde is 1000.
-
Klik op Nieuwe genereren om te starten met het generen van API-sleutels. Hiermee wordt u omgeleid naar de sectie API-sleutels op de pagina van uw gebruikersprofiel, waar u nieuwe sleutels kunt maken.
API-sleutels genereren
U kunt API-sleutels vanuit uw profiel genereren. Controleer voordat u begint of aan de volgende twee vereisten is voldaan:
-
U hebt een actieve licentie.
- API-sleutels inschakelen is ingeschakeld in het Beheer-activiteitencentrum.
- U hebt de rol Developer.
Doe het volgende:
-
Klik rechtsboven op het pictogram van uw gebruikersprofiel en selecteer Profielinstellingen.
-
In de sectie API-sleutels klikt u op Nieuwe sleutel genereren.
-
Geef een beschrijving en verlooptijd voor de API-sleutel op.
-
Klik op Genereren om de sleutel te maken.
-
Kopieer direct de gegenereerde API-sleutel en sla deze veilig op. U kunt de sleutel later niet meer ophalen.
Nadat u de API -sleutel heeft gemaakt, kunt u de naam ervan wijzigen of de sleutel indien nodig verwijderen.
Met uw API-sleutel kunt u de referenties voor REST API voor qlik.dev bekijken, voor het gebruik van middelen zoals Postman in qlik-cli installeren om direct vanuit de opdrachtregel toegang te krijgen tot Qlik-functies. Ga voor meer informatie naar Overzicht van Qlik API's en qlik-cli.
API-sleutels bewaken en intrekken
Als tenantbeheerder is het van essentieel belang om vanwege veiligheidsredenen de activiteiten van API-sleutels te bewaken. U kunt de API-sleutel intrekken als er verdachte activiteiten worden gedetecteerd.
Houd er rekening mee dat de API-sleutel direct wordt gedeactiveerd als u deze intrekt. Dit kan van invloed zijn op doorlopende processen en integraties die van de sleutel afhankelijk zijn. Intrekken kan niet ongedaan worden gemaakt en een ingetrokken API-sleutel kan niet opnieuw worden geactiveerd.
Doe het volgende:
-
Ga in het Beheer-activiteitencentrum naar de sectie Gebeurtenissen.
-
Zoek naar verdachte activiteiten, zoals overmatig gebruik van een specifieke API-sleutel.
-
Klik op naast de gebeurtenis om de details uit te vouwen en de API-sleutel-id te kopiëren.
-
Ga naar de sectie API-sleutels en zoek naar de API-sleutel die deze id gebruikt.
-
Klik op naast de sleutel en selecteer Intrekken. U kunt alleen sleutels intrekken die de status Actief hebben.
-
Om meerdere API-sleutels in te trekken, selecteert u de sleutels in de tabel en klikt u op Intrekken in de rechterbovenhoek.
API-sleutels verwijderen
Door API-sleutels permanent te verwijderen, worden ze uit het systeem verwijderd. Het verwijderen van een API-sleutel kan niet ongedaan worden gemaakt en de toegangsmachtigingen worden onmiddellijk verwijderd. Zorg dat deze actie geen doorlopende processen of integraties verstoort die afhankelijk zijn van de sleutel.
U moet de rol Developer hebben om API-sleutels te verwijderen.
Doe het volgende:
-
Klik rechtsboven op het pictogram van uw gebruikersprofiel en selecteer Profielinstellingen.
-
Selecteer de sectie API-sleutels.
-
Klik op naast de API-sleutel die u wilt verwijderen en klik op Verwijderen.
-
Klik op Alles verwijderen boven de lijst met API-sleutels als u alle sleutels wilt verwijderen.