Integracje
Sekcja pozwala dodawać i konfigurować aplikacje API oraz Serwisy rozproszone wykorzystywane do integracji z zewnętrznymi aplikacjami i usługami.
API
Wybierając tę zakładkę, administrator zostaje przeniesiony do okna Aplikacje z dostępem do API.
Widoczna jest tutaj lista wszystkich aplikacji API skonfigurowanych na danym środowisku z wyszczególnieniem App Client ID, Nazwy, Loginu użytkownika (w formacje UPN) oraz Typu aplikacji.
Dedykowane przyciski w oknie pozwalają tworzyć nowe lub edytować i usuwać istniejące aplikacje API.
Edycja aplikacji
Kliknięcie na przycisk Nowa aplikacja lub Edytuj w oknie Aplikacje z dostępem do API otwiera stronę edycji aplikacji API.
Typ aplikacji oraz dane logowania
Sekcja zawiera podstawowe informacje dotyczące aplikacji API, takie jak nazwa czy automatycznie wygenerowany Client ID.
Przy korzystaniu z REST API WEBCON BPS obsługuje uwierzytelnianie OAuth2. Wspierane są dwa scenariusze uwierzytelniania przy użyciu OAuth2, tzw. typy aplikacji:
- Kontekst aplikacji – służy do komunikacji między usługami. Do uwierzytelniania wykorzystuje przepływ autoryzacji. W przypadku tego typu aplikacji tworzone jest również konto użytkownika w WEBCON BPS, któremu można następnie przydzielić uprawnienia, zadania itp.
- Kontekst użytkownika – w tym przypadku aplikacja działa w kontekście istniejącego użytkownika i korzysta z jego uprawnień. Do uwierzytelniania wykorzystuje przepływ kodu autoryzacyjnego, w związku z czym uzyskanie tokenu wymaga interakcji użytkownika.
Klucze tajne
Aplikacja API do uwierzytelniania OAuth2 wykorzystuje zarówno Client ID, jak i Klucze tajne. Identyfikator Client ID jest generowany podczas rejestracji aplikacji, podczas gdy Klucz tajny można generować ręcznie (po zapisaniu aplikacji). Każda aplikacja może mieć dokładnie jeden identyfikator Client ID (którego nie można zmienić) oraz wiele Kluczy tajnych wykorzystywanych w różnych systemach. Nowe Klucze tajne można tworzyć za pomocą przycisku Generuj nowe klucze tajne klienta. Wówczas pojawi się okno, w którym podany zostanie klucz i można dodatkowo wprowadzić opis ułatwiający jego późniejszą identyfikację.
Każdy nowo wygenerowany Klucz tajny należy zapisać, ponieważ jest on wyświetlany tylko jeden raz i nie ma możliwości jego przywrócenia.
Identyfikatorów Client ID oraz Kluczy tajnych nie należy nikomu udostępniać (podobnie jak haseł), ponieważ mogą one zostać wykorzystane do uzyskania dostępu do danych WEBCON BPS i wykonywania czynności, takich jak np. odczyt, edycja lub usuwanie elementów obiegu. Należy regularnie sprawdzać utworzone klucze tajne i usuwać te, które nie są już potrzebne.
Uprawnienia aplikacji (zakresy)
Sekcja umożliwia określenie zakresu uprawnień, jakie integrująca aplikacja API będzie miała w systemie. Wybranie przycisku Edytuj otwiera okno z listą dostępnych uprawnień. Zawartość listy uprawnień determinowana jest typem aplikacji API, tj. będzie różnić się w kontekście aplikacji i w kontekście użytkownika. Dla każdego rodzaju uprawnienia z listy pod ikoną (i) dostępny jest opis. Zaznaczenie pola wyboru w kolumnie Stan obok nazwy uprawnienia jest jednoznaczne z jego nadaniem aplikacji API. Wybrane uprawnienia będą wykorzystywane do ograniczania dostępu za pomocą access tokenu.
Autoryzowane URI przekierowania
Opcja dostępna tylko w przypadku aplikacji działającej w kontekście użytkownika. Po pomyślnym uwierzytelnieniu aplikacji przez użytkownika serwer autoryzacji BPS przekieruje użytkownika z powrotem do aplikacji tylko wtedy, gdy skonfigurowano żądany zwrotny adres URL. Ponieważ adres URL przekierowania będzie zawierał poufne informacje, ważne jest, aby usługa przekierowywała użytkownika wyłącznie do zaufanych lokalizacji.
Konfiguracja przepływów autoryzacji
Opcja jest dostępna dla obu typów działania aplikacji API, jednak jej rozbudowana wersja obowiązuje w kontekście użytkownika. Umożliwia konfigurację przepływu uwierzytelnienia, a w szczególności określenie, czy aplikacja będzie mogła korzystać z Refresh tokenów. Możliwe jest takie skonfigurowanie aplikacji API, by w trakcie uwierzytelnienia użytkownikowi wyświetlany był zakres uprawnień wymaganych przez tę aplikację. Użytkownik ma wówczas możliwość akceptacji lub odrzucenia żądanego zakresu uprawnień.
Lista aplikacji, dla których użytkownik zaakceptował uprawnienia, dostępna jest z poziomu zakładki Bezpieczeństwo w menu użytkownika. W tym miejscu użytkownik może również wycofać udzieloną wcześniej zgodę na dostęp do systemu przez aplikację w jego imieniu.
Sekcja pozwala również określić Czas życia Access/Refresh tokenu.
Więcej na temat REST API można przeczytać na stronie https://developer.webcon.com/docs/rest-api (strona w języku angielskim).
Serwisy rozproszone
Serwisy rozproszone to komponenty pośredniczące w komunikacji WEBCON BPS z systemami i technologiami zewnętrznymi. Odpowiadają za wymianę informacji między elementami systemów, koordynację i zarządzanie usługami oraz przepływ danych. Po wybraniu tego węzła w menu nawigacji otwierane jest następujące okno:
Jest to lista wszystkich serwisów rozproszonych skonfigurowanych na danym środowisku z wyszczególnieniem Client ID, Nazwy, Loginu użytkownika (w formacje UPN) oraz Roli serwisu (Wydruk etykiet).
Dedykowane przyciski w oknie pozwalają tworzyć nowe lub edytować i usuwać istniejące serwisy.
Edycja serwisu rozproszonego
Kliknięcie na przycisk Nowy serwis rozproszony lub Edytuj w oknie Serwisy rozproszone otwiera stronę edycji serwisu.
Dane logowania
Sekcja zawiera nazwę Serwisu rozproszonego oraz login użytkownika, w kontekście którego serwis będzie działał. Login należy podawać w formacie UPN. Identyfikator Client ID, podobnie jak w przypadku REST API, dla każdego serwisu generowany jest automatycznie.
Klucze tajne
Serwis rozproszony do uwierzytelniania OAuth2 wykorzystuje zarówno Client ID, jak i Klucze tajne. Identyfikator Client ID jest generowany podczas rejestracji serwisu, podczas gdy Klucz tajny można generować ręcznie (po zapisaniu serwisu). Każdy serwis może mieć dokładnie jeden identyfikator Client ID (którego nie można zmienić) oraz wiele Kluczy tajnych wykorzystywanych w różnych systemach. Nowe Klucze tajne można tworzyć za pomocą przycisku Generuj nowe klucze tajne klienta. Wówczas pojawi się okno, w którym podany zostanie klucz i można dodatkowo wprowadzić opis ułatwiający jego późniejszą identyfikację.
Każdy nowo wygenerowany Klucz tajny należy zapisać, ponieważ jest on wyświetlany tylko jeden raz i nie ma możliwości jego przywrócenia.
Role serwisu
Zaznaczając pole wyboru Wydruk etykiet, użytkownik może zdecydować, czy skonfigurowany serwis rozproszony będzie wykorzystywany do wydruku etykiet z kodami kreskowymi na podstawie wcześniej przygotowanych szablonów. Pole jest domyślnie zaznaczone.
Proces dodawania nowego Serwisu rozproszonego i przyznawania mu roli został opisany w artykule Wydruk etykiet kodów kreskowych w środowisku WEBCONAPPS-SaaS na naszym blogu technicznym.