Dotyczy wersji: 2020.1.x i wyższych; autor: Tomasz Słuszniak
Jednym ze sposobów wystartowania obiegu w WEBCON BPS może być wykorzystanie REST API BPS. Może on być szczególnie przydatny w takich sytuacjach jak:
- Wymiana danych między różnymi instancjami BPS – np. instancja działająca wyłącznie wewnątrz organizacji oraz instancja publiczna, dostępna np. dla naszych klientów
- Wymiana danych z systemami firm trzecich np. CRM, ERP
Przykład wykorzystania – startowanie obiegu za pomocą REST API w procesie projektowym.
Pierwszym krokiem będzie utworzenie aplikacji, która umożliwi dostęp do API – w WEBCON BPS Portal należy wejść w zakładkę „Administracja”, a następnie z zakładki „Integracje” wybrać API i utworzyć nową aplikację za pomocą przycisku „Nowa aplikacja”.
Na ekranie pojawi się okno, w którym należy uzupełnić dane aplikacji. W przypadku uruchamiania obiegu przez REST API, jako autor będzie widoczny użytkownik którego dane uzupełniane są w polach Nazwa, Login oraz E-mail. Login musi być wpisany w formacie UPN i nie może się powtarzać (w AD nie może być użytkownika o takim samym loginie).
Impersonacja – opcja umożliwia wykonanie operacji przez REST API w imieniu innego użytkownika. Można także określić w jakich aplikacjach Impersonacja będzie możliwa.
Po zapisaniu aplikacji kolejnym krokiem będzie utworzenie prywatnego klucza wykorzystywanego podczas wywołania REST API – kliknij przycisk „Generuj nowy sekret”.
Tak wygenerowany klucz należy zapisać, ponieważ jego ponowne wyświetlenie nie będzie możliwe.
Aby mieć możliwość wykonywania operacji przez REST API należy się zalogować – w tym celu użyj danych zapisanych podczas tworzenie aplikacji API. Potrzebne będą dane ClientID oraz ClientSecret (prywatny klucz). Podczas uruchamiania obiegu będzie wykorzystywana także opcja impersonacji, aby użyć kontekstu pracownika i np. uniemożliwić wykonanie operacji, do których użytkownik nie ma uprawnień (np. brak możliwości startowania lub edytowania elementu obiegu).
Aby się zalogować, należy wysłać żądanie metodą POST na adres:
http://adres_portalu_webcon_bps/api/login
W odpowiedzi otrzymamy token, który umożliwi nam wykonywanie kolejnych operacji przez REST API.
Token należy przekazywać jako nagłówek w kolejnych żądaniach.
Aby wystartować obieg należy wysłać żądanie POST na adres:
http://adres_portalu_webcon_bps/api/data/v2.0/db/1/elements?path=<GUID_ścieżki_przejścia>
GUID ścieżki lub innych obiektów BPS można uzyskać z BPS Designer Studio klikając na przycisk obok ID danego obiektu:
Przykładowy adres żądania:
http://wdr04/api/data/v2.0/db/1/elements?path=89083a10-b8f4-44f8-b500-df2cb417aa98
W BODY żądania należy przekazać parametry startowanego obiegu:
Wszystkie potrzebne GUID’y obiektów znajdziemy w BPS Designer Studio jak na przykładzie.
W odpowiedzi takiego żądania otrzymamy ID, Sygnaturę oraz Status:
Obieg został poprawnie wystartowany, a wynik operacji można zweryfikować na formularzu w BPS Portal:
Wywołanie REST API uruchomiło również akcję „Uruchom podobieg (SQL)”, która została skonfigurowana w pierwszym przykładzie.
Szczegółowy opis REST API oraz WEBCON BPS SDK dostępny jest pod adresem: https://developer.webcon.com/resources/
