Wstęp

Narzędzie Efecte Service Management (ESM) zawiera otwarte API , które umożliwia połączenie z dowolnym systemem zewnętrznym. Połączenie to jest możliwe dzięki interfejsowi REST API , który ułatwia nowoczesną integrację z różnymi aplikacjami zewnętrznymi. Zbudowane w oparciu o zasady REST , API oferuje wszechstronny i efektywny sposób obsługi danych w ramach platformy.

Interfejs REST API Efecte oferuje wszechstronne funkcje, które mają na celu wsparcie programistów, usprawnienie integracji i poprawę współpracy różnych systemów.

Organizacje, niezależnie od swojej wielkości, korzystają z licznych, powiązanych ze sobą systemów i procesów. Systemy te mogą funkcjonować w obrębie jednego działu lub obejmować wiele działów. Integrując te kluczowe systemy, organizacje mogą znacznie ograniczyć pracę ręczną. Interfejs REST API Efecte wspomaga to zadanie, oferując bezpieczny i łatwy w obsłudze interfejs dla programistów.

Aby aktywować REST API w dowolnym środowisku Efecte, należy upewnić się, że narzędzie Efecte Service Management (ESM) jest zaktualizowane do wersji 2021.4 lub nowszej. Aktywacja wymaga uzyskania licencji REST API od Efecte, która umożliwia włączenie modułu Efecte External API w systemie. Dodatkowo, skonfigurowanie użytkownika technicznego (lokalnego) i zdefiniowanie jego roli to niezbędne kroki w celu zarządzania dostępem.

Należy pamiętać, że REST API nie obejmuje funkcji administracyjnych ani zarządzania modelem danych w systemie Efecte. Szczegółowy opis możliwości REST API można znaleźć w naszej dokumentacji REST API Efecte.

Zalecane scenariusze

REST API jest przydatny w wielu sytuacjach, w których zachodzi potrzeba wysłania lub odebrania danych z ESM. Jest to podstawowy wybór dla klientów i partnerów Efecte podczas tworzenia połączeń z ESM. Typowe zastosowania obejmują pobieranie danych o zasobach i konfiguracji z narzędzi inwentaryzacyjnych, łączenie się z innymi platformami ITSM lub ticketingowymi, łączenie z systemami ERP, synchronizację z systemami HR oraz łączenie się z narzędziami do raportowania i analiz.

Dokumentacja

Dokumentację REST API można znaleźć, klikając łącza poniżej.

• Przegląd interfejsu REST API
• Opis interfejsu REST API

Oprócz standardowej dokumentacji, Efecte oferuje również dokumentację online dostępną za pośrednictwem Swagger – praktycznego narzędzia do interakcji z API i przeglądania szczegółowej dokumentacji. Ten zasób online jest łatwo dostępny w każdym środowisku z ważną licencją REST API . Dostęp do interfejsu użytkownika Swagger można uzyskać, przechodząc do adresu URL bazowego, a następnie wpisując adres /rest-api/itsm/v1/docs/swagger/index.html (na przykład https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html ).

Swagger tworzy tę dokumentację zgodnie ze specyfikacją Open API 3.0. Co więcej, dokumentację tę można pobrać z interfejsu użytkownika pod adresem URL bazowym, a następnie z pliku /rest-api/itsm/v1/docs/openapi.json . Po pobraniu dokumentację można zaimportować do różnych narzędzi integracyjnych i testowych, takich jak Postman, co ułatwia eksplorację i testowanie API .