API-nycklar

En API-nyckel låter ett annat program använda AurionAI API för din organisation. Varje nyckel har en lista med behörigheter, kallade scope. En nyckel kan bara utföra det som dess scope tillåter.

Tillgänglighet: alla profiler. Endast administratörer.

Förutsättningar

• Du har rollen Ägare eller Administratör. Övriga användare ser Åtkomst nekad.
• Du vet vad programmet behöver göra, så att du ger det endast de scope det behöver.

Öppna API-nycklarna

1. Välj Konfiguration i sidofältet.
2. Öppna kategorin System.
3. Välj API-nycklar.

Tabellen Aktiva nycklar visar namn, början av nyckeln, scope, status, skapandedatum, senaste användning och utgångsdatum för varje nyckel. Återkallade nycklar listas under Återkallade nycklar.

Skapa en nyckel

1. Välj Skapa nyckel.
2. I Namn, ange ett namn som anger vilket program som använder nyckeln.
3. Valfritt: i Beskrivning (valfritt), beskriv vad nyckeln är till för.
4. I Utgång, välj när nyckeln går ut. Standardvärdet är 90 dagar. Du kan också välja Ingen utgång.
5. Under Behörigheter, välj scope. En gruppruta väljer alla scope i gruppen.
6. Välj Skapa nyckel.
7. Kopiera nyckeln med Kopiera API-nyckel. AurionAI visar den fullständiga nyckeln endast denna enda gång.
8. Välj Jag har kopierat den — stäng.

Programmet skickar nyckeln i X-API-Key-headern för varje begäran. En nyckel börjar med itsm_sk_live_, eller med itsm_sk_test_ för en sandlådeorganisation.

Scope

Noteringar om scope:

• För att publicera kunskapsbasartiklar med bilder behöver en nyckel kb:read, kb:write och kb:media. Med enbart kb:read och kb:write kan den inte ladda upp bilder. Det finns inget scope för att ta bort artiklar.
• För att exportera ett samtalsutskrift behöver en nyckel conversations:read, conversations:write och conversations:export; nycklar skapade innan conversations:export existerade kan inte exportera förrän du skapar en ersättningsnyckel med det.
• Det finns inget scope för "alla behörigheter". Välj varje scope som programmet behöver.

Rotera en nyckel

Rotera en nyckel när du misstänker att någon annan känner till den.

1. I kolumnen Åtgärder för nyckeln, välj Rotera nyckel.
2. I dialogrutan Rotera API-nyckel, välj Rotera nyckel.
3. Kopiera den nya nyckeln. Den gamla nyckeln slutar fungera. Uppdatera programmet med den nya nyckeln.

Den nya nyckeln behåller namn, scope och utgångsdatum från den gamla.

Återkalla en nyckel

1. I kolumnen Åtgärder för nyckeln, välj Återkalla nyckel.
2. I dialogrutan Återkalla API-nyckel, välj Återkalla nyckel.

Meddelandet API-nyckel återkallad visas. Program som använder nyckeln förlorar åtkomst omedelbart. Det går inte att ångra detta.

Resultat

En ny nyckel fungerar omedelbart, med enbart sina scope. Kolumnen Status visar Aktiv, Upphör snart under de sista sju dagarna före utgång, Utgången eller Återkallad.

Om något går fel

• Välj minst en behörighet Välj minst ett scope.
• Det gick inte att skapa API-nyckel Försök igen. Om det misslyckas igen, kontakta AurionAI support. Läs Få hjälp.
• Hemlighet ej tillgänglig AurionAI visade inte nyckeln. Använd inte denna nyckel. Återkalla den och skapa en ny.
• Du har tappat bort nyckeln. AurionAI kan inte visa den igen. Rotera nyckeln eller skapa en ny.
• En begäran med nyckeln nekas. Nyckeln saknar scope för denna begäran, eller så är den utgången eller återkallad. Kontrollera kolumnerna Omfattningar och Status.
• Ett program kan inte ladda upp bilder till kunskapsbasen. Lägg till kb:media: skapa en ny nyckel med kb:read, kb:write och kb:media.

Relaterade artiklar

• Developer API: användning och webhooks
• Anslut dina ITSM- och CS-verktyg
• Få hjälp