REST API

Administratorzy tworzą tokeny Bearer z określonymi zakresami dla aplikacji zewnętrznych.

Przegląd

Ta strona opisuje obsługę i najważniejsze skutki działania funkcji REST API. Jeśli zmiany wpływają na istniejące zgłoszenia, uprawnienia, powiadomienia lub automatyzacje, należy je najpierw sprawdzić w środowisku testowym.

Typowy przepływ pracy

  1. Wyszukać użytkownika dla tokenu. Użyj dostępnych widoków wyszukiwania, filtrowania i szczegółów. Wyczyść lub zmień filtry, jeśli oczekiwane rekordy się nie pojawiają.

  2. Utworzyć token z nazwą i zakresami. Otwórz odpowiedni formularz administracyjny lub formularz działania, wprowadź wymagane wartości i zapisz dopiero po sprawdzeniu przypisań oraz pól obowiązkowych.

  3. Bezpiecznie przejąć wartość tokenu. Wykonaj funkcję w przeznaczonym do tego formularzu i od razu sprawdź wynik w odpowiednim zestawieniu lub przy danym zgłoszeniu.

  4. Wyłączyć token. Najpierw sprawdź, których istniejących rekordów lub użytkowników dotyczy zmiana. W miarę możliwości użyj dezaktywacji zamiast trwałego usunięcia.

  5. Zrozumieć rejestrowanie żądań i idempotencję. Wykonaj funkcję w przeznaczonym do tego formularzu i od razu sprawdź wynik w odpowiednim zestawieniu lub przy danym zgłoszeniu.

  6. Otworzyć opis OpenAPI. Wykonaj funkcję w przeznaczonym do tego formularzu i od razu sprawdź wynik w odpowiednim zestawieniu lub przy danym zgłoszeniu.

Uwagi

  • Widoczne pozycje menu i działania zależą od uprawnień grupowych i programowych zalogowanego agenta.

  • Wyłączone wpisy często pozostają zachowane dla istniejących zgłoszeń i analiz, ale nie są już dostępne dla nowych przypisań.

  • Po zmianach przetestuj co najmniej jeden realistyczny przypadek użycia z użytkownikiem objętej roli.

REST API