Hantera API-nycklar

API-nycklar är unika identifierare för autentisering så att användare, utvecklare och program kan komma åt API:erna på ett säkert sätt. De är nödvändiga för att spåra och kontrollera användningen av API:er och hjälper till att förhindra missbruk och säkerställer säker kommunikation.

Använda API-nycklar för att koppla upp sig mot Qlik Cloud-API:er

Du kan använda API-nycklar för att interagera med REST API-referensen på Qlik.dev. Verktyg som Postman eller Qlik-cli kan användas för API-åtkomst. Mer information finns i Översikt över Qlik-API:er och qlik-cli.

Exempel: Använd Postman för att koppla upp sig mot Qlik API:er

Gör följande:

Starta Postman.
Ställ in HTTP-metoden på GET.
Skriv in URL:en för Qlik Clouds API-slutpunkt.

Exempelvis för att lista alla utrymmen i klientorganisationen:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
På fliken Auth väljer du Bearer Token som Auth Type.
Ange din API-nyckel i Token-fältet.
Klicka på Skicka.

Om begäran lyckas kommer API att returnera ett JSON-svar. I det här exemplet skulle svaret inkludera en lista med utrymmen.

Aktivera API-nycklar i klientorganisationen

Som standard är generering av API-nycklar inaktiverat. Klientorganisationsadministratörer måste aktivera API-nycklar i klientorganisationen för att användare ska kunna generera dem.

Gör följande:

Gå till Utrymmen i aktivitetscentret för Administration.
Välj Aktivera API-nycklar under API-nycklar.
Justera vid behov följande inställningar:
- Ändra maximal utgångstid för token: modifiera utgångstiden för token som nyss har genererats. Befintliga API-nycklar behåller sitt ursprungliga utgångsvärde. Det finns inget maxvärde för det här värdet.
- Ändra maximalt antal aktiva API-nycklar per användare: denna inställning påverkar endast nya API-nycklar. Om gränsen nås kommer det inte att vara möjligt att skapa nya API-nycklar. Maxvärdet är 1 000.
Anteckning om informationDu kan behöva uppdatera din webbläsare för att se ändringarna i detta värde återspeglas i avsnittet API-nycklar på din användarprofilsida.
För att börja generera API-nycklar klickar du på Generera nya. Du kommer att omdirigeras till delavsnittet API-nycklar i din användarprofil.

Generera och hantera API-nycklar

Generera API-nycklar

För att skapa en API-nyckel måste du ha rollen Utvecklare . Klientorganisationsadministratörer kan också tilldela användare den här rollen.

Gör följande:

Klicka på din profil och välj Profilinställningar.
I delavsnittet API-nycklar väljer du Generera ny nyckel.
Ange en beskrivning och utgångstid för API-nyckeln.
Klicka på Generera för att skapa nyckeln.
Kopiera omedelbart den genererade API-nyckeln och förvara den på ett säkert sätt. Observera att nyckeln inte kan hämtas senare.

Redigera API-nycklar

Du kan ändra namnet på en API-nyckel efter att den har skapats.

Ta bort API-nycklar

Radering av API-nycklar är permanent och kan inte ångras. Säkerställ att denna åtgärd inte stör några pågående processer eller integreringar som beror på nyckeln.

Gör följande:

Klicka på din profil och välj Profilinställningar.
Gå till delavsnittet API-nycklar.
Klicka på intill den API-nyckel du vill ta bort och välj Ta bort.
Om du vill ta bort alla nycklar klickar du på Ta bort alla ovanför listan med nycklar.

Övervaka och återkalla API-nycklar

I delavsnittet API-nycklar i aktivitetscentret för Administration kan du visa alla API-nycklar som är associerade med din klientorganisation. Du kan söka efter nycklar via namn, ID eller ägare.

Status för API-nycklar

API-nycklar kan ha följande statusar:

Aktiv: API-nyckeln används för närvarande.
Upphört: utgångsdatumet har passerats.
Återkallad: API-nyckeln har återkallats och kan inte längre användas.

Återkalla av API-nycklar

Som klientorganisationsadministratör är det av säkerhetsskäl mycket viktigt att aktivt övervaka API-nyckelaktiviteter. Om du upptäcker misstänkta aktiviteter kan du återkalla API-nyckeln.

En återkallad API-nyckel inaktiveras omedelbart, vilket påverkar alla pågående processer eller integreringar som är beroende av den. Återkallning kan inte ångras och en återkallad API-nyckel kan inte återaktiveras.

Gör följande:

Gå till Händelser i aktivitetscentret för Administration.
Håll uppsikt över eventuella misstänkta aktiviteter, till exempel ovanligt stor användning av en viss API-nyckel.
Klicka på bredvid händelsen för att utöka dess detaljer och kopiera API-nyckelns ID.
Gå till avsnittet API-nycklar och leta efter API-nyckeln med hjälp av dess ID.
Klicka på intill nyckeln och välj Återkalla. Du kan bara återkalla nycklar med statusen Aktiv.
För att återkalla flera API-nycklar väljer du dem i tabellen och klickar på Återkalla längst upp till höger.

Bästa praxis för hantering av API-nycklar

Håll nycklarna konfidentiella: Lagra API-nycklar på ett säkert sätt och undvik att exponera dem i offentliga databaser.
Förnya regelbundet: Förnya dina API-nycklar regelbundet för att förbättra säkerheten.
Övervaka användningen: Kontrollera regelbundet API-nycklarnas aktiviteter för att identifiera misstänkt beteende.

Var den här sidan till hjälp för dig?

Om du hittar några fel på denna sida eller i innehållet – ett stavfel, ett steg som saknas eller ett tekniskt fel – berätta för oss så att vi kan blir bättre!

Lämna din feedback här