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 voor interactie met de Qlik REST API-referentie. Tools zoals Postman of qlik-cli kunnen worden gebruikt voor API-toegang. Zie Overzicht van Qlik-API's en qlik-cli voor meer informatie.

API-referenties bieden directe programmatische toegang tot Qlik Cloud en zijn niet beperkt tot workflows die beschikbaar zijn in de gebruikersinterface. Wijs rollen en OAuth-scopes toe op basis van het principe van minimale rechten. Behandel serviceaccounts en API-referenties met dezelfde mate van zorgvuldigheid als beheerdersreferenties. Zie voor meer informatie API-toegangsbeheer en vertrouwensgrenzen.

Voorbeeld: Postman gebruiken om verbinding te maken met Qlik-API's

Doe het volgende:

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

Bijvoorbeeld om alle ruimten in de tenant weer te geven:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Kies op het tabblad Auth voor Bearer Token als het Auth Type.
Voer uw API-sleutel in in het Token veld.
Klik op Send.

Als de aanvraag is geslaagd, retourneert de API een JSON-respons. In dit voorbeeld zou de respons een lijst met ruimten bevatten.

Instellingen voor API-sleutels configureren

Doe het volgende:

Ga in het activiteitencentrum Beheer naar de pagina Instellingen.
Selecteer het tabblad Functiebeheer.
Pas in de sectie API-sleutels de volgende instellingen naar wens aan:
- Maximale vervaltijd van token wijzigen: stel de vervalperiode in voor nieuw gegenereerde API-tokens. Bestaande API-sleutels behouden hun oorspronkelijke vervalwaarde. 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 is alleen van toepassing op nieuwe sleutels. Als de limiet is bereikt, kunnen gebruikers geen extra sleutels maken. De maximale waarde is 1000.

Mogelijk moet u uw browser vernieuwen om de wijzigingen te zien in de sectie API-sleutels van uw persoonlijke instellingenpagina.

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 zijn ingeschakeld in de instellingen voor Standaardgebruiker.

Doe het volgende:

Klik op uw gebruikersprofielpictogram en selecteer Instellingen.
Ga naar de sectie API-sleutels en klik op Nieuwe sleutel genereren.
Geef een beschrijving op en stel een vervaltijd in voor de API-sleutel.
Klik op Genereren om de sleutel te maken.
Kopieer de gegenereerde API-sleutel en bewaar deze veilig. Let op: de sleutel kan later niet meer worden opgehaald.

API-sleutels bewerken

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

API-sleutels verwijderen

Het verwijderen van API-sleutels is permanent en kan niet ongedaan worden gemaakt. Zorg ervoor dat deze actie geen lopende processen of integraties verstoort die afhankelijk zijn van de sleutel.

Doe het volgende:

Klik op uw gebruikersprofielpictogram en selecteer Instellingen.
Ga naar de sectie API-sleutels.
Klik op naast de API-sleutel die u wilt verwijderen en selecteer Verwijderen.
Om alle sleutels te verwijderen, klikt u op Alles verwijderen boven de lijst met sleutels.

API-sleutels bewaken en intrekken

U kunt alle API-sleutels die aan uw tenant zijn gekoppeld, bekijken in de sectie API-sleutels van het activiteitencentrum Beheer. U kunt zoeken naar sleutels op naam, ID of eigenaar.

Statussen van API-sleutels

API-sleutels kunnen de volgende statussen hebben:

Actief: de API-sleutel is momenteel in gebruik.
Verlopen: de vervaldatum is bereikt.
Ingetrokken: de API-sleutel is ingetrokken en kan niet meer worden gebruikt.

API-sleutels intrekken

Als tenant-beheerder is het actief bewaken van API-sleutelactiviteiten essentieel voor het handhaven van de beveiliging. Als er verdachte activiteiten worden gedetecteerd, kunt u de API-sleutel intrekken.

Het intrekken van een API-sleutel deactiveert deze onmiddellijk, wat van invloed is op lopende processen of integraties die ervan afhankelijk zijn. Intrekking is onomkeerbaar; een ingetrokken API-sleutel kan niet opnieuw worden geactiveerd.

Doe het volgende:

Ga in het activiteitencentrum Beheer naar Gebeurtenissen.
Zoek naar verdachte activiteiten, zoals overmatig gebruik van een bepaalde 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 met behulp van de ID.
Klik op naast de sleutel en selecteer Intrekken. U kunt alleen sleutels met de status Actief intrekken.
Om meerdere API-sleutels in te trekken, selecteert u ze in de tabel en klikt u op Intrekken in de rechterbovenhoek.

Best practices voor het beheer van API-sleutels

Houd sleutels vertrouwelijk: bewaar API-sleutels veilig en vermijd blootstelling ervan in openbare code-repository's.
Regelmatig opnieuw genereren: genereer uw API-sleutels periodiek 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