Ga naar inhoud
AurionAI

API-sleutels

4 min leestijdDoor Emmanuel Yazbeck

Een API-sleutel stelt een ander programma in staat om de AurionAI API te gebruiken voor uw organisatie. Elke sleutel heeft een lijst met machtigingen, ook wel scopes genoemd. Een sleutel kan alleen doen wat de bijbehorende scopes toestaan.

Beschikbaarheid: alle profielen. Alleen beheerders.

Vereisten

  • U heeft de rol Eigenaar of Beheerder. Andere gebruikers zien Toegang geweigerd.
  • U weet wat het programma moet doen, zodat u het alleen de benodigde scopes geeft.

De API-sleutels openen

  1. Selecteer Configuratie in de zijbalk.
  2. Open de categorie Systeem.
  3. Selecteer API-sleutels.

De tabel Actieve sleutels toont de naam, het begin van de sleutel, de scopes, de status, de aanmaakdatum, het laatste gebruik en de vervaldatum van elke sleutel. Ingetrokken sleutels worden weergegeven onder Ingetrokken sleutels.

De pagina API-sleutels met de lijst van sleutels.

Een sleutel aanmaken

  1. Selecteer Sleutel maken.
  2. Typ in Naam een naam die aangeeft welk programma de sleutel gebruikt.
  3. Optioneel: beschrijf in Beschrijving (optioneel) waarvoor de sleutel bedoeld is.
  4. Kies in Vervaldatum wanneer de sleutel vervalt. De standaardwaarde is 90 dagen. U kunt ook Geen vervaldatum kiezen.
  5. Selecteer onder Machtigingen de scopes. Een groepsvakje selecteert alle scopes van de groep.
  6. Selecteer Sleutel maken.
  7. Kopieer de sleutel met API-sleutel kopiëren. AurionAI toont de volledige sleutel slechts één keer.
  8. Selecteer Ik heb hem gekopieerd — sluiten.

Het programma stuurt de sleutel mee in de X-API-Key-header van elk verzoek. Een sleutel begint met itsm_sk_live_, of met itsm_sk_test_ voor een sandbox-organisatie.

Scopes

Groep Scopes
Gesprekken conversations:read, conversations:write, conversations:export
Tickets tickets:read, tickets:write
Oproepen calls:read, calls:write
Gebruik usage:read
Webhooks webhooks:read, webhooks:write, webhooks:delete
Kennisbank kb:read (Artikelen lezen), kb:write (Artikelen schrijven), kb:media (Artikelafbeeldingen uploaden)

Opmerkingen over de scopes:

  • Om kennisbankartikelen met afbeeldingen te publiceren, heeft een sleutel kb:read, kb:write en kb:media nodig. Met alleen kb:read en kb:write kunnen geen afbeeldingen worden geüpload. Er is geen scope om artikelen te verwijderen.
  • Om een gesprekstranscript te exporteren, heeft een sleutel conversations:read, conversations:write en conversations:export nodig; sleutels die zijn aangemaakt voordat conversations:export bestond, kunnen pas exporteren nadat u een vervangende sleutel met deze scope heeft aangemaakt.
  • Er is geen scope voor "alle machtigingen". Selecteer elke scope die het programma nodig heeft.

Een sleutel roteren

Roteer een sleutel wanneer u vermoedt dat iemand anders deze kent.

  1. Selecteer in de kolom Acties van de sleutel de optie Sleutel roteren.
  2. Selecteer in het dialoogvenster API-sleutel roteren de optie Sleutel roteren.
  3. Kopieer de nieuwe sleutel. De oude sleutel werkt niet meer. Werk het programma bij met de nieuwe sleutel.

De nieuwe sleutel behoudt de naam, de scopes en de vervaldatum van de oude sleutel.

Een sleutel intrekken

  1. Selecteer in de kolom Acties van de sleutel de optie Sleutel intrekken.
  2. Selecteer in het dialoogvenster API-sleutel intrekken de optie Sleutel intrekken.

Het bericht API-sleutel ingetrokken verschijnt. Programma's die de sleutel gebruiken, verliezen onmiddellijk de toegang. Dit kan niet ongedaan worden gemaakt.

Resultaat

Een nieuwe sleutel werkt onmiddellijk, uitsluitend met de bijbehorende scopes. De kolom Status toont Actief, Verloopt binnenkort in de laatste zeven dagen voor de vervaldatum, Verlopen of Ingetrokken.

Als er iets misgaat

  • Selecteer ten minste één machtiging Selecteer ten minste één scope.
  • Kan API-sleutel niet maken Probeer het opnieuw. Als het opnieuw mislukt, neem dan contact op met de AurionAI-ondersteuning. Lees Hulp krijgen.
  • Geheim niet beschikbaar AurionAI heeft de sleutel niet getoond. Gebruik deze sleutel niet. Trek hem in en maak een nieuwe aan.
  • U bent de sleutel kwijtgeraakt. AurionAI kan deze niet opnieuw tonen. Roteer de sleutel of maak een nieuwe aan.
  • Een verzoek met de sleutel wordt geweigerd. De sleutel mist de scope voor dit verzoek, of de sleutel is verlopen of ingetrokken. Controleer de kolommen Scopes en Status.
  • Een programma kan geen afbeeldingen uploaden naar de kennisbank. Voeg kb:media toe: maak een nieuwe sleutel aan met kb:read, kb:write en kb:media.

Gerelateerde artikelen

Komt u er nog niet uit? Dien een aanvraag in of .