API -sleutels beheren

API-sleutels dienen als unieke id's voor authenticatie, zodat gebruikers, ontwikkelaars of programma's veilig toegang krijgen tot API's. Ze zijn essentieel voor het bijhouden en controleren van API-gebruik, helpen misbruik te voorkomen en zorgen voor veilige communicatie.

video thumbnail

API-sleutels gebruiken om verbinding te maken met Qlik Cloud API's.

U kunt API-sleutels gebruiken om te werken met de Qlik REST API-referentie. Tools zoals Postman of qlik-cli kunnen worden gebruikt voor API-toegang. Ga voor meer informatie naar Overzicht van Qlik API's en qlik-cli.

Voorbeeld: verbinding maken met Qlik API's met behulp van Postman.

Doe het volgende:

Start Postman.
Stel de HTTP-methode in op GET.
Voer de URL voor het Qlik Cloud API-eindpunt in.

Om bijvoorbeeld alle ruimten in de tenant op te sommen:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Op het tabblad Auth kiest u Bearer-token als Auth-type.
Voer in het veld Token uw API-sleutel in.
Klik op Verzenden.

Als de aanvraag succesvol is, stuurt de API een JSON-antwoord terug. In dit voorbeeld zou het antwoord een lijst met ruimten bevatten.

API-sleutels inschakelen in de tenant

Deze instelling is afgeschaft en wordt verwijderd in een toekomstige release. Na verwijdering wordt het aanmaken van API-sleutels uitsluitend geregeld door de machtiging API-sleutels beheren.

Tenantbeheerders kunnen beheren of gebruikers API-sleutels in de tenant mogen genereren.

Doe het volgende:

In het Beheer-activiteitencentrum gaat u naar Instellingen.
Selecteer het tabblad Functiebeheer.
Schakel in de sectie API-sleutels API-sleutels inschakelen in of uit.

Instellingen van API-sleutels configureren

Doe het volgende:

In het Beheer-activiteitencentrum gaat u naar Instellingen.
Selecteer het tabblad Functiebeheer.
Pas in de sectie API-sleutels indien nodig de volgende instellingen aan:
- Maximale vervaldatum van token wijzigen: stel de vervalperiode voor nieuw gegenereerde API-tokens in. Bestaande API-sleutels behouden hun originele verloopwaarde. Er is geen bovengrens voor deze waarde.
- Maximum aantal actieve API-sleutels per gebruiker wijzigen: stel de limiet in voor het aantal API-sleutels dat een gebruiker kan hebben. Deze limiet geldt alleen voor nieuwe sleutels. Als de limiet bereikt is, kunnen gebruikers geen extra sleutels meer aanmaken. De maximumwaarde is 1000.

U moet mogelijk uw browser vernieuwen om de wijzigingen te zien in de sectie API-sleutels op de pagina van uw persoonlijke instellingen.

API‑sleutels genereren en beheren

API-sleutels genereren

Om nieuwe API-sleutels te genereren, moet u een aangepaste rol hebben met de machtiging API-sleutels beheren, of de machtiging moet ingeschakeld zijn in de instellingen Standaardgebruiker.

Doe het volgende:

Klik op het pictogram van uw gebruikersprofiel en selecteer Instellingen.
Ga naar de sectie API-sleutels en klik op Nieuwe sleutel genereren.
Geef een beschrijving op en stel de verlooptijd voor de API-sleutel in.
Klik op Genereren om de sleutel te maken.
Kopieer de gegenereerde API-sleutel en sla deze veilig op. U kunt de sleutel later niet meer ophalen.

API-sleutels bewerken

U kunt de naam van een API-sleutel wijzigen na het aanmaken ervan.

API-sleutels verwijderen

API-sleutels worden permanent verwijderd en dit kan niet ongedaan worden gemaakt. Zorg dat deze actie geen doorlopende processen of integraties verstoort die afhankelijk zijn van de sleutel.

Doe het volgende:

Klik op het pictogram van uw gebruikersprofiel en selecteer Instellingen.
Ga naar 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 om alle sleutels te verwijderen.

API-sleutels bewaken en intrekken

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‑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.

API-sleutels intrekken

Als tenantbeheerder is het van essentieel belang om vanwege veiligheidsredenen de activiteiten van API-sleutels actief te bewaken. U kunt de API-sleutel intrekken als er verdachte activiteiten worden gedetecteerd.

Door het intrekken wordt de API-sleutel direct gedeactiveerd. 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 naar Gebeurtenissen in het Beheer-activiteitencentrum.
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.

Aanbevolen procedures voor het beheer van API-sleutels

Houd sleutels vertrouwelijk: sla API-sleutels veilig op en vermijd blootstelling in openbare code-opslagplaatsen.
Regelmatig opnieuw genereren: genereer uw API-sleutels regelmatig opnieuw om de beveiliging te verbeteren.
Gebruik bewaken: controleer regelmatig de activiteiten van API-sleutels om verdacht gedrag te identificeren.

Was deze pagina nuttig?

Als u problemen ervaart op deze pagina of de inhoud onjuist is – een tikfout, een ontbrekende stap of een technische fout – laat het ons weten!

Geef hier uw feedback