Hantera API-nycklar | Qlik CloudHjälp
Gå till huvudinnehåll Gå till ytterligare innehåll
Qlik-resurser
Laddar sökning med SearchUnify Om du behöver hjälp med din produkt, kontakta Qlik Support.
Qlik kundportal
Laddar sökning med SearchUnify Om du behöver hjälp med din produkt, kontakta Qlik Support.
Qlik kundportal

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.

video thumbnail

Använda API-nycklar för att ansluta till Qlik Cloud-API:er

Du kan använda API-nycklar för att interagera med Qlik REST API-referens. 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.

Anteckning om information

API-autentiseringsuppgifter ger direkt programmatisk åtkomst till Qlik Cloud och är inte begränsade till arbetsflöden som är tillgängliga i användargränssnittet. Tilldela roller och OAuth-omfattningar enligt principen om minsta möjliga behörighet. Hantera tjänstekonton och API-autentiseringsuppgifter med samma omsorg som autentiseringsuppgifter för administratörer. Mer information finns i API-åtkomstkontroll och förtroendegränser.

Exempel: Använda Postman för att ansluta till Qlik-API:er

Gör följande:

  1. Starta Postman.

  2. Ställ in HTTP-metoden på GET.

  3. Ange URL:en för Qlik Cloud-API-slutpunkten.

    Till exempel, för att lista alla utrymmen i klientorganisationen:

    https://your-tenant.eu.qlikcloud.com/api/v1/spaces

  4. På fliken Auth väljer du Bearer Token som Auth Type.

  5. Ange din API-nyckel i Token -fältet.

  6. Klicka på Send.

Om begäran lyckas returnerar API:et ett JSON-svar. I det här exemplet skulle svaret innehålla en lista över utrymmen.

Konfigurera inställningar för API-nycklar

Gör följande:

  1. I aktivitetscentret Administration går du till sidan Inställningar.

  2. Välj fliken Funktionskontroll.

  3. I delavsnittet API-nycklar justerar du följande inställningar efter behov:

    • Ändra maximal förfallotid för token: Ställ in förfalloperioden för nyligen genererade API-token. Befintliga API-nycklar behåller sitt ursprungliga förfallovärde. Det finns ingen övre gräns för detta värde.

    • Ändra maximalt antal aktiva API-nycklar per användare: Ställ in gränsen för hur många API-nycklar en användare kan ha. Denna gräns gäller endast för nya nycklar. Om gränsen nås kommer användare inte att kunna skapa ytterligare nycklar. Det maximala värdet är 1000.

Du kan behöva uppdatera din webbläsare för att se ändringarna återspeglas i delavsnittet API-nycklar på din personliga inställningssida.

Generera och hantera API-nycklar

Generera API-nycklar

För att generera nya API-nycklar måste du ha en anpassad roll med behörigheten Hantera API-nycklar, eller så måste behörigheten vara aktiverad i inställningarna för Användarstandard.

Gör följande:

  1. Klicka på din användarprofilikon och välj Inställningar.

  2. Gå till delavsnittet API-nycklar och klicka på Generera ny nyckel.

  3. Ange en beskrivning och ställ in en förfallotid för API-nyckeln.

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

  5. Kopiera den genererade API-nyckeln och förvara den säkert. 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

Anteckning om informationBorttagning av API-nycklar är permanent och kan inte ångras. Se till att denna åtgärd inte stör några pågående processer eller integrationer som är beroende av nyckeln.

Gör följande:

  1. Klicka på din användarprofilikon och välj Inställningar.

  2. Gå till delavsnittet API-nycklar.

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

  4. För att ta bort alla nycklar klickar du på Ta bort alla ovanför listan med nycklar.

Övervaka och återkalla API-nycklar

Du kan visa alla API-nycklar som är kopplade till din klientorganisation i delavsnittet API-nycklar i aktivitetscentret Administration. Du kan söka efter nycklar via namn, ID eller ägare.

Statusar för API-nycklar

API-nycklar kan ha följande statusar:

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

Återkalla API-nycklar

Som administratör för en klientorganisation är det viktigt att aktivt övervaka API-nyckelaktiviteter för att upprätthålla säkerheten. Om misstänkta aktiviteter upptäcks kan du återkalla API-nyckeln.

Anteckning om informationNär du återkallar en API-nyckel inaktiveras den omedelbart, vilket påverkar alla pågående processer eller integrationer som är beroende av den. Återkallandet är oåterkalleligt; en återkallad API-nyckel kan inte återaktiveras.

Gör följande:

  1. I aktivitetscentret Administration går du till Händelser.

  2. Leta efter misstänkta aktiviteter, till exempel överdriven användning av en viss API-nyckel.

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

  4. Gå till delavsnittet API-nycklar och sök efter API-nyckeln med hjälp av dess ID.

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

  6. För att återkalla flera API-nycklar markerar du dem i tabellen och klickar på Återkalla i det övre högra hörnet.

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

  • Håll nycklar konfidentiella: Förvara API-nycklar säkert och undvik att exponera dem i offentliga kodförråd.

  • Regenerera regelbundet: Regenerera dina API-nycklar med jämna mellanrum för att förbättra säkerheten.

  • Övervaka användning: Kontrollera regelbundet API-nyckelaktiviteter för att identifiera misstänkt beteende.

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

Om du stöter på några problem med den här sidan eller innehållet på den, t.ex. ett stavfel, ett saknat steg eller ett tekniskt fel – meddela oss!

Lämna din feedback här