Gå till huvudinnehåll

Hantera API-nycklar

En API-nyckel är en unik identifierare som används för att autentisera en användare eller utvecklare, eller för att anropa program till ett API. API-nycklar används ofta för att spåra och kontrollera hur gränssnittet används så att missbruk av API:t kan förhindras.

Översikt av API-nycklar

Som standard är API-nycklarna inaktiverade i Management Console. Om du vill aktivera API-nycklarna går du till avsnittet Inställningar. En huvudadministratör kan återkalla API-nycklar och redigera inställningarna för API-nycklar, men bara användare med rollen utvecklare kan generera eller ta bort API-nycklar. Användaren tilldelas rollen utvecklare av en huvudadministratör. Om du är huvudadministratör kan du ge dig själv rollen utvecklare.

Tabellen API-nycklar visar följande information om API-nycklarna: namn, ID, ägare, senaste uppdatering, datum den skapades, utgångsdatum och status. I sökfältet kan du söka i de tre första fälten: Nyckelns namn, Nyckelns ID och Ägare.

Statusar för API-nycklar

Status för API-nycklar kan vara något av följande:

  • Aktiv: API-nyckeln används.
  • Förfallit: utgångsdatumet har inträffat.
  • Återkallad: API-nyckeln har återkallats och kan inte användas.

Som admin kan du granska API-nycklarnas aktiviteter som registreras i delavsnittet Händelser i Management Console. Om tvivelaktiga aktiviteter upptäcks, till exempel extensiv användning av en viss API-nyckel, kan du återkalla den API-nyckeln. Öppna den detaljerade listan genom att klicka på pilen till höger i tabellen och kopiera API-nyckelns ID. Sedan kan du söka efter ID:t i avsnittet API-nycklar för att hitta API-nyckeln som ska återkallas.

Om du vill återkalla en enstaka API-nyckel klickar du på knappen ... längst till höger och väljer Återkalla. Du kan bara återkalla nycklar med statusen Aktiv. Om du vill återkalla flera nycklar väljer du kryssrutorna till vänster om nycklarna som ska återkallas och klickar på Återkalla längst upp till höger. Återkallandet kan inte ångras. En återkallad API-nyckel kan inte aktiveras igen.

Utöver att återkalla finns även alternativet att ta bort. Du kan ta bort en API-nyckel från hubben men inte i Management Console.

Aktivera API-nycklar i klientorganisationen

Inställningen Aktivera API-nycklar aktiveras på sidan Inställningar i Management Console. Som standard är API-nycklarna inaktiverade i Management Console.

Egenskaper för API-nycklar
Egenskap Beskrivning
Aktivera API -nycklar

Den här växeln aktiverar eller inaktiverar alla API-nycklar i klientorganisationen. Endast huvudadministratören kan aktivera API-nycklarna.

Ändra maximal utgångstid för token

När värdet för utgångsdatum för token ändras, får alla nya token det nya utgångsdatumet. Befintliga API:er kommer inte att påverkas av ändringen, de behåller samma utgångsvärde.

Ändra maximalt antal API-nycklar per användare

Den här inställningen påverkar bara nya API-nycklar. Om en ny API-nyckel medför att det totala antalet nycklar överskrider maximalt antal kan inte nyckeln skapas.

Gör följande:

  1. Gå till sidan Inställningar i Management Console.
  2. Aktivera knappen Aktivera API-nycklar i delavsnittet API-nycklar.
  3. Ändra vid behov inställningarna Ändra maximal utgångstid för token och Ändra maximalt antal API-nycklar per användare.

Generera en API-nyckel från hubben

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

  • Du använder en licens. En licens krävs för att generera en API-nyckel.

  • Inställningen Aktivera API-nycklar är påsatt i Management Console.
  • Du har tilldelats rollen utvecklare av huvudadministratören.

Gör följande:

  1. Logga in till din klientorganisation, till exempel https://<klientorganisationsnamn>.com.

  2. Klicka på din profil längst upp till höger och välj Profilinställningar.

  3. Välj API-nycklar.

  4. Klicka på Generera ny nyckel.

  5. Ange en beskrivning för API-nyckeln och välj när API-nyckeln ska löpa ut.

  6. Klicka på Generera.

    En API-nyckel genereras.

  7. Kopiera API-nyckeln och spara den på en säker plats.

När du har skapat API-nyckeln kan du redigera namnet. Du kan även ta bort den.