Spis treści:

Informacje podstawowe

Interfejs programowania aplikacji (z ang. application programming interface) lub API, posiada strukturę i reguły umożliwiające skuteczną komunikację między aplikacjami i oprogramowaniami. Jest pośrednikiem pomiędzy aplikacją a serwerem www i działa jako pośredni kanał przesyłania danych między systemami. 
REST, czyli Representational State Transfer to styl architektury oprogramowania, opierający się o zbiór określonych reguł opisujących jak definiowane są zasoby, a także umożliwiających dostęp do nich. 

LOG Plus REST API działa w następujący sposób: 

Aplikacja lub oprogramowanie wysyła żądanie, które zostaje następnie przekazane do serwera www; 
Po zatwierdzeniu żądania, API przekazuje je do serwera www (lub, w stosownych przypadkach, do programu zewnętrznego); 
Serwer www wysyła następnie odpowiedź do API; 
API zwraca otrzymane informacje aplikacji, która wystosowała żądanie.

Działanie REST API polega na umożliwieniu klientom kierowania żądań do serwera przy użyciu określonych metod HTTP zwanych inaczej czasownikami. Należą do nich: 

GET – służący do pobierania zasobu według ustalonego identyfikatora. 
POST – odpowiada za tworzenie nowych zasobów, pobierania danych wymagających dostarczania dodatkowych parametrów oraz wykonywanie operacji nienależących do innych metod. 
PUT – czasownik HTTP aktualizujący zasoby na podstawie podanego identyfikatora. 
DELETE – jego zadaniem jest usuwanie zasobu zgodnie z wprowadzonym identyfikatorem. 
PATCH – odpowiada za aktualizacje części zasobu.

LOG Plus REST API pozwala na: 

zasilanie systemu danymi o zasobach,  
pobieranie informacji z zewnętrznych systemów informatycznych, 
tworzenie, odczytywanie, aktualizowanie i usuwanie danych w LOG Plus,  
automatyzację niektórych zadań i optymalizację funkcji.

Swagger to narzędzie, które służy do tworzenia dokumentacji API (interfejsu programistycznego aplikacji). Dzięki Swaggerowi możliwe jest łatwe tworzenie i edytowanie dokumentacji API, a także udostępnianie jej innym osobom.

Pierwsze kroki

Systemowe polecenia REST API systemu LOG Plus dostępne są pod: adres_witryny/swagger. Polecenia API uporządkowane są w kolejności alfabetycznej według kategorii zasobów, których dotyczą. Wykonanie dowolnego polecenia wymaga uzyskania autoryzacji użytkownika. Należy w tym celu:

Przejść do kategorii Accounts
Wyszukać i wybrać polecenie /api/Accounts/LogIn (User authentication)
Kliknąć przycisk Try it out
Następnie należy wpisać login i hasło użytkownika posiadającego uprawnienia administracyjne (czynność oznaczona cyfrą 1), a następnie kliknąć przycisk Execute (czynność oznaczona cyfrą 2).
W oknie Response body, zostanie wygenerowany klucz służący do uzyskania autentyfikacji. Klucz ten należy skopiować.
Należy powrócić do góry strony, następnie kliknąć przycisk Authorize (czynność oznaczona 1) i wkleić skopiowany klucz do pola Value okna modalnego (czynność 2) i kliknąć Authorize.
Po prawidłowym zalogowaniu okno modalne wyglądać będzie jak poniżej:
Należy je zamknąć klikając przycisk Close.

Po wygaśnięciu ważności tokenu należy ponownie wykonać kroki od a do h, aby móc kontynuować pracę w swaggerze.

Opis najczęściej wykonywanych czynności

Wymuszenie przesłania danych z Agenta do hurtowni danych

W celu wymuszenia wykonania audytu do hurtowni danych na wskazanym komputerze, należy uzyskać autoryzację w Swaggerze wykonując kroki a-h z punktu 2-go, a następnie wyszukać polecenie: /api/Computers/force-audit-warehouse i w nie kliknąć. Następnie należy kliknąć przycisk Try it out, wpisać w dostępnym polu ID komputera z tabeli CMDB -> Komputery, a następnie Execute. Po kilku-kilkunastu minutach dane z Agenta powinny być widoczne w bazie danych.

Zmniejszenie rozmiaru lokalnej bazy danych Agenta

W celu wymuszenia zmniejszenia pliku lokalnej bazy Agenta (database.fdb) na wskazanym komputerze, należy uzyskać autoryzację w Swaggerze wykonując kroki a-h z punktu 2-go, a następnie wyszukać polecenie: /api/Computers/shrink-agent-database i w nie kliknąć. Następnie należy kliknąć przycisk Try it out, wpisać w dostępnym polu ID komputera z tabeli CMDB -> Komputery, a następnie Execute. Po kilku-kilkunastu minutach plik database.fdb na wybranym komputerze powinien zostać zmniejszony.

Usunięcie „zerowych” pozycji oprogramowania

„Zerowe” pozycje oprogramowania pojawiają się w momencie odinstalowania danej wersji oprogramowania (np. aktualizacja przeglądarki do wyższych wersji). Ich hurtowe usunięcie z tabeli CMDB -> Oprogramowanie jest możliwe z poziomu Swaggera. Należy w tym celu wykonać kroki a-h z punktu 2-go, a następnie wyszukać polecenie: DELETE /api/Software i kliknąć Try it out. Polecenie to uruchamiane jest bez parametrów po kliknięciu Execute.

Dokumentacja LOG Plus

REST API LOG Plus