API-nøgler

En API-nøgle giver et andet program mulighed for at bruge AurionAI API på vegne af din organisation. Hver nøgle har en liste over tilladelser, kaldet scopes. En nøgle kan kun gøre det, dens scopes tillader.

Tilgængelighed: alle profiler. Kun administratorer.

Forudsætninger

• Du har rollen Ejer eller Administrator. Andre brugere ser Adgang nægtet.
• Du ved, hvad programmet skal gøre, så du kun giver det de scopes, det har brug for.

Åbn API-nøglerne

1. Vælg Konfiguration i sidebjælken.
2. Åbn kategorien System.
3. Vælg API-nøgler.

Tabellen Aktive nøgler viser navn, starten af nøglen, scopes, status, oprettelsesdato, seneste brug og udløbsdato for hver nøgle. Tilbagekaldte nøgler vises under Tilbagekaldte nøgler.

Opret en nøgle

1. Vælg Opret nøgle.
2. I Navn skal du skrive et navn, der angiver, hvilket program der bruger nøglen.
3. Valgfrit: i Beskrivelse (valgfrit) kan du beskrive, hvad nøglen bruges til.
4. I Udløb skal du vælge, hvornår nøglen udløber. Standarden er 90 dage. Du kan også vælge Intet udløb.
5. Under Tilladelser skal du vælge scopes. Et gruppeafkrydsningsfelt vælger alle scopes i gruppen.
6. Vælg Opret nøgle.
7. Kopiér nøglen med Kopiér API-nøgle. AurionAI viser den fulde nøgle kun denne ene gang.
8. Vælg Jeg har kopieret den — luk.

Programmet sender nøglen i X-API-Key-headeren for hver anmodning. En nøgle starter med itsm_sk_live_ eller med itsm_sk_test_ for en sandkasseorganisation.

Scopes

Bemærkninger om scopes:

• For at udgive vidensbaseartikler med billeder skal en nøgle have kb:read, kb:write og kb:media. Med kun kb:read og kb:write kan den ikke uploade billeder. Der er intet scope til at slette artikler.
• For at eksportere en opkaldsudskrift skal en nøgle have conversations:read, conversations:write og conversations:export; nøgler oprettet før conversations:export fandtes, kan ikke eksportere, før du opretter en erstatningsnøgle med det.
• Der er intet "alle tilladelser"-scope. Vælg hvert scope, som programmet har brug for.

Roter en nøgle

Roter en nøgle, hvis du mener, at en anden kender den.

1. I kolonnen Handlinger for nøglen skal du vælge Rotér nøgle.
2. I dialogen Rotér API-nøgle skal du vælge Rotér nøgle.
3. Kopiér den nye nøgle. Den gamle nøgle holder op med at virke. Opdater programmet med den nye nøgle.

Den nye nøgle beholder navn, scopes og udløbsdato fra den gamle.

Tilbagekald en nøgle

1. I kolonnen Handlinger for nøglen skal du vælge Tilbagekald nøgle.
2. I dialogen Tilbagekald API-nøgle skal du vælge Tilbagekald nøgle.

Beskeden API-nøgle tilbagekaldt vises. Programmer, der bruger nøglen, mister adgang med det samme. Dette kan ikke fortrydes.

Resultat

En ny nøgle virker med det samme, kun med dens scopes. Kolonnen Status viser Aktiv, Udløber snart i de sidste syv dage før udløb, Udløbet eller Tilbagekaldt.

Hvis noget går galt

• Vælg mindst én tilladelse Vælg mindst ét scope.
• Kunne ikke oprette API-nøgle Prøv igen. Hvis det mislykkes igen, skal du kontakte AurionAI-support. Læs Få hjælp.
• Hemmelighed utilgængelig AurionAI viste ikke nøglen. Brug ikke denne nøgle. Tilbagekald den og opret en ny.
• Du har mistet nøglen. AurionAI kan ikke vise den igen. Roter nøglen, eller opret en ny.
• En anmodning med nøglen afvises. Nøglen mangler scopet for denne anmodning, eller den er udløbet eller tilbagekaldt. Kontrollér kolonnerne Omfang og Status.
• Et program kan ikke uploade billeder til vidensbasen. Tilføj kb:media: opret en ny nøgle med kb:read, kb:write og kb:media.

Relaterede artikler

• Developer API: brug og webhooks
• Forbind dine ITSM- og CS-værktøjer
• Få hjælp