Hantera API-nycklar

API-nycklar fungerar som unika identifierare för autentisering så att användare, utvecklare och program kan komma åt API på ett säkert sätt. API-nycklar används ofta för att spåra och kontrollera API-användning så att missbruk kan förhindras.

Översikt av API-nycklar

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

API-nycklar kan ha följande statusar:

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

Huvudadministratörer kan både aktivera generering av API-nycklar och återkalla API-nycklar. För att generera, redigera eller ta bort API-nycklar krävs rollen utvecklare. Huvudadministratörer kan tilldela den här rollen till användare, sig själva inkluderat.

Aktivera API-nycklar i klientorganisationen

Som standard är API-nycklar inaktiverade. Huvudadministratörer kan aktivera API-nycklar i klientorganisationen.

Gör följande:

1. I Hanteringskonsol går du till Inställningar.
2. Leta upp avsnittet API-nycklar och välj Aktivera API-nycklar.
3. Justera vid behov följande inställningar:

   • Ändra maximal utgångstid för token: modifierar utgångstiden för token som just har genererats. Befintliga API-nycklar behåller sitt ursprungliga utgångsvärde. Det finns inget maxvärde för det här värdet.

     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
   • Ä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.

4. För att börja generera API-nycklar klickar du på Generera nya. Detta kommer att omdirigera dig till avsnittet API-nycklar på din användarprofilsida, där du kan skapa nya nycklar.

Generera API-nycklar

Du kan generera API-nycklar från hubben. Försäkra dig om att följande krav är uppfyllda innan du börjar:

• Du har en aktiv licens.

• Aktivera API-nycklar är påslagen i Hanteringskonsol.
• Du har rollen Utvecklare.

Gör följande:

1. Klicka på din användarprofilikon längst upp till höger och välj Profilinställningar.

2. I avsnittet API-nycklar väljer du Generera ny nyckel.

3. Ange en beskrivning och utgångstid för API-nyckeln.

4. Klicka på Generera för att skapa nyckeln.

5. Kopiera omedelbart den genererade API-nyckeln och förvara den på ett säkert sätt. Nyckeln kan inte hämtas senare.

När du har skapat API-nyckeln kan du redigera namnet eller ta bort den vid behov.

Med din API-nyckel kan du utforska REST API-referensen på qlik.dev med hjälp av verktyg som Postman, eller installera qlik-cli för att få tillgång till Qlik-funktioner direkt från kommandoraden. Mer information finns i Översikt över Qlik-API:er och qlik-cli.

Övervaka och återkalla API-nycklar

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

Kom ihåg att en API-nyckel omedelbart inaktiveras när den återkallas, 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:

1. I Hanteringskonsol går du till avsnittet Händelser.

2. Håll uppsikt över eventuella misstänkta aktiviteter, till exempel ovanligt stor användning av en viss API-nyckel.

3. Klicka på bredvid händelsen för att utöka dess detaljer och kopiera API-nyckelns ID.

4. Gå till avsnittet API-nycklar och leta efter API-nyckeln med hjälp av dess ID.

5. Klicka på intill nyckeln och välj Återkalla. Du kan bara återkalla nycklar med statusen Aktiv.

6. För att återkalla flera API-nycklar väljer du dem i tabellen och klickar på Återkalla längst upp till höger.

Ta bort API-nycklar

När API-nycklar tas bort försvinner de permanent från systemet. Det går inte att ångra borttagningen av en API-nyckel och dess åtkomstbehörigheter tas omedelbart bort. Säkerställ att denna åtgärd inte stör några pågående processer eller integreringar som beror på nyckeln.

Du behöver rollen Utvecklare för att ta bort API-nycklar.

Gör följande:

1. Klicka på din användarprofilikon längst upp till höger och välj Profilinställningar.

2. Välj avsnittet API-nycklar.

3. Klicka på intill den API-nyckel du vill ta bort och välj Ta bort.

4. Om du vill ta bort alla nycklar klickar du på Ta bort alla ovanför listan med API-nycklar.