Klucze API

Klucz API umożliwia innemu programowi korzystanie z interfejsu API AurionAI w imieniu Twojej organizacji. Każdy klucz posiada listę uprawnień zwanych zakresami. Klucz może wykonywać tylko te działania, na które pozwalają jego zakresy.

Dostępność: wszystkie profile. Tylko administratorzy.

Wymagania wstępne

• Posiadasz rolę Właściciel lub Administrator. Pozostali użytkownicy widzą Brak dostępu.
• Wiesz, co program ma robić, aby przyznać mu tylko niezbędne zakresy.

Otwieranie kluczy API

1. Na pasku bocznym wybierz Konfiguracja.
2. Otwórz kategorię System.
3. Wybierz Klucze API.

Tabela Aktywne klucze wyświetla nazwę, początek klucza, zakresy, status, datę utworzenia, datę ostatniego użycia oraz datę wygaśnięcia każdego klucza. Odwołane klucze są wymienione w sekcji Unieważnione klucze.

Tworzenie klucza

1. Wybierz Utwórz klucz.
2. W polu Nazwa wpisz nazwę wskazującą, który program używa klucza.
3. Opcjonalnie: w polu Opis (opcjonalnie) opisz, do czego służy klucz.
4. W polu Wygaśnięcie wybierz, kiedy klucz wygasa. Domyślnie jest to 90 dni. Możesz również wybrać Bez wygaśnięcia.
5. W sekcji Uprawnienia wybierz zakresy. Zaznaczenie pola wyboru grupy powoduje wybranie wszystkich zakresów w tej grupie.
6. Wybierz Utwórz klucz.
7. Skopiuj klucz za pomocą Kopiuj klucz API. AurionAI wyświetla pełny klucz tylko jeden raz.
8. Wybierz Skopiowałem — zamknij.

Program wysyła klucz w nagłówku X-API-Key każdego żądania. Klucz zaczyna się od itsm_sk_live_ lub od itsm_sk_test_ w przypadku organizacji sandbox.

Zakresy

Uwagi dotyczące zakresów:

• Aby publikować artykuły bazy wiedzy z obrazami, klucz wymaga zakresów kb:read, kb:write i kb:media. Przy samych zakresach kb:read i kb:write przesyłanie obrazów nie jest możliwe. Nie istnieje zakres umożliwiający usuwanie artykułów.
• Aby wyeksportować transkrypcję rozmowy, klucz wymaga zakresów conversations:read, conversations:write i conversations:export; klucze utworzone przed wprowadzeniem zakresu conversations:export nie mogą eksportować danych, dopóki nie utworzysz nowego klucza z tym zakresem.
• Nie istnieje zakres „wszystkie uprawnienia". Wybierz każdy zakres, którego potrzebuje program.

Rotacja klucza

Wykonaj rotację klucza, gdy podejrzewasz, że ktoś inny go poznał.

1. W kolumnie Akcje przy danym kluczu wybierz Rotuj klucz.
2. W oknie dialogowym Rotuj klucz API wybierz Rotuj klucz.
3. Skopiuj nowy klucz. Stary klucz przestaje działać. Zaktualizuj program, podając nowy klucz.

Nowy klucz zachowuje nazwę, zakresy i datę wygaśnięcia poprzedniego.

Odwoływanie klucza

1. W kolumnie Akcje przy danym kluczu wybierz Unieważnij klucz.
2. W oknie dialogowym Unieważnij klucz API wybierz Unieważnij klucz.

Wyświetli się komunikat Klucz API unieważniony. Programy korzystające z tego klucza natychmiast tracą dostęp. Tej operacji nie można cofnąć.

Wynik

Nowy klucz działa natychmiast, wyłącznie w ramach przypisanych zakresów. Kolumna Status wyświetla wartość Aktywny, Wkrótce wygasa w ciągu ostatnich siedmiu dni przed wygaśnięciem, Wygasły lub Unieważniony.

Jeśli coś pójdzie nie tak

• Wybierz co najmniej jedno uprawnienie Wybierz co najmniej jeden zakres.
• Nie udało się utworzyć klucza API Spróbuj ponownie. Jeśli błąd się powtórzy, skontaktuj się z pomocą techniczną AurionAI. Przeczytaj Uzyskaj pomoc.
• Sekret niedostępny AurionAI nie wyświetlił klucza. Nie używaj tego klucza. Odwołaj go i utwórz nowy.
• Utracono klucz. AurionAI nie może go ponownie wyświetlić. Wykonaj rotację klucza lub utwórz nowy.
• Żądanie z kluczem zostało odrzucone. Klucz nie posiada zakresu wymaganego dla tego żądania, albo wygasł lub został odwołany. Sprawdź kolumny Zakresy i Status.
• Program nie może przesyłać obrazów do bazy wiedzy. Dodaj zakres kb:media: utwórz nowy klucz z zakresami kb:read, kb:write i kb:media.

Powiązane artykuły

• Interfejs API dla deweloperów: użycie i webhooki
• Połącz swoje narzędzia ITSM i CS
• Uzyskaj pomoc