Ga naar hoofdinhoud Ga naar aanvullende inhoud
Qlik-bronnen

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.

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

U kunt API-sleutels gebruiken om te werken met de REST API-referentie op qlik.dev. 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:

  1. Start Postman.

  2. Stel de HTTP-methode in op GET.

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

  4. Op het tabblad Auth kiest u Bearer-token als Auth-type.

  5. Voer in het veld Token uw API-sleutel in.

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

Het genereren van API-sleutels is standaard uitgeschakeld. Tenantbeheerders moeten API-sleutels inschakelen in de tenant zodat gebruikers ze kunnen genereren.

Doe het volgende:

  1. In het Beheer-activiteitencentrum gaat u naar Instellingen.
  2. Onder API-sleutelsselecteert u API-sleutels inschakelen.

  3. Pas indien nodig de volgende instellingen aan:

    • Maximale vervaldatum van token wijzigen: wijzig de verloopdatum voor nieuw gegenereerde tokens. Bestaande API-sleutels behouden hun originele verloopwaarde. Er is geen maximumlimiet voor deze waarde.

    • Maximale aantal actieve API-sleutels per gebruiker wijzigen: dit limiet is alleen van toepassing op nieuwe API-sleutels. Als de limiet is bereikt, is het maken van aanvullende API-sleutels niet mogelijk. De maximumwaarde die u kunt instellen is 1000.
    InformatieU moet mogelijk uw browser vernieuwen om de wijzigingen te zien in de sectie API-sleutels op de pagina van uw gebruikersprofiel.

  4. Klik op Nieuwe genereren om te starten met het generen van API-sleutels. U wordt omgeleid naar de sectie API-sleutels van uw gebruikersprofiel.

API‑sleutels genereren en beheren

API-sleutels genereren

U moet beschikken over de rol Ontwikkelaar om nieuwe API-sleutels te genereren. Tenantbeheerders kunnen de rol ook toewijzen aan gebruikers.

Doe het volgende:

  1. Klik op het pictogram van uw gebruikersprofiel en selecteer Profielinstellingen.

  2. Ga naar de sectie API-sleutels en klik op Nieuwe sleutel genereren.

  3. Geef een beschrijving op en stel de verlooptijd voor de API-sleutel in.

  4. Klik op Genereren om de sleutel te maken.

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

InformatieAPI-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:

  1. Klik op het pictogram van uw gebruikersprofiel en selecteer Profielinstellingen.

  2. Ga naar de sectie API-sleutels.

  3. Klik op Meer naast de API-sleutel die u wilt verwijderen en klik op Verwijderen.

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

InformatieDoor 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:

  1. Ga naar Gebeurtenissen in het Beheer-activiteitencentrum.

  2. Zoek naar verdachte activiteiten, zoals overmatig gebruik van een specifieke API-sleutel.

  3. Klik op Pijl-omlaag naast de gebeurtenis om de details uit te vouwen en de API-sleutel-id te kopiëren.

  4. Ga naar de sectie API-sleutels en zoek naar de API-sleutel die deze id gebruikt.

  5. Klik op Meer naast de sleutel en selecteer Intrekken. U kunt alleen sleutels intrekken die de status Actief hebben.

  6. 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 typfout, een ontbrekende stap of een technische fout – laat het ons weten zodat we dit kunnen verbeteren!

Geef hier uw feedback