OTOBO / Znuny Web Services - REST API

Wprowadzenie do integracji interfejsów zewnętrznych

INFO

Ten artykuł o usługach sieciowych ma duże pokrycie z artykułem REST API REST API.

W globalnie połączonym świecie systemy obsługi zgłoszeń muszą być w stanie automatycznie reagować na zapytania z innych systemów, a także wysyłać zapytania lub dane do usług zewnętrznych. OTOBO, potężny system obsługi zgłoszeń typu open-source, odpowiada na to wyzwanie za pomocą swojego Interfejsu Generycznego. Umożliwia on administratorom, bez głębokiej wiedzy programistycznej, tworzenie usług sieciowych do różnorodnych zadań. OTOBO obsługuje komunikację za pomocą protokołów REST i SOAP, umożliwiając bezproblemową integrację z:

• Systemami CRM
• Systemami zarządzania projektami
• Systemami zarządzania dokumentacją
• i wieloma innymi aplikacjami

Usługa sieciowa działa jako łącznik między OTOBO a systemami zewnętrznymi. Operacje i Invoker definiują kierunek komunikacji, podczas gdy Mapping i Transport określają, jak dane są przesyłane i interpretowane. Dzięki OTOBO możesz konfigurować usługi sieciowe do wykonywania akcji wewnętrznych, inicjowania zapytań w systemach zdalnych, zarządzania konwersją danych między systemami i określania protokołu komunikacyjnego.

Dostęp do usług sieciowych znajduje się w module Usługi Sieciowe w grupie Procesy i Automatyzacja. Świeża instalacja OTOBO domyślnie nie zawiera wstępnie skonfigurowanych usług sieciowych. Poniżej dokumentacja ilustruje, jak tworzyć, edytować, usuwać, klonować, eksportować i importować usługi sieciowe, a także jak korzystać z narzędzia debugowania. W tym celu należy odwołać się do kroków szczegółowo opisanych w oficjalnej dokumentacji administracyjnej OTOBO.

Implementacja Interfejsów

Implementacja usług sieciowych w OTOBO umożliwia elastyczną i dynamiczną integrację procesów biznesowych z licznymi narzędziami i systemami zewnętrznymi. Poprzez generowanie i wykorzystanie tych usług zwiększa się efektywność poprzez redukcję ręcznych interwencji i skrócenie czasu odpowiedzi na zapytania klientów. Ponadto, wszechstronność interfejsu generycznego zapewnia, że OTOBO jest niemal nieograniczenie rozszerzalny i doskonale wpasowuje się w istniejące krajobrazy IT.

Bezpieczeństwo i Konfiguracja

W odniesieniu do konfiguracji i bezpieczeństwa usług sieciowych należy pamiętać, że podczas eksportu wszystkie zapisane hasła są eksportowane w postaci czystego tekstu. Przechowywanie i obchodzenie się z hasłami powinno być zatem traktowane ze szczególną ostrożnością.

Aby uzyskać szczegółowe informacje na temat konfiguracji wewnętrznej systemu, takie jak możliwości konfiguracji modułów cache i frontend, zalecamy zapoznanie się z dokumentem otobo-system-configuration.txt. To źródło zawiera kompleksowy przegląd wszystkich opcji konfiguracji.

Dokumentacja Połączeń

Usługi sieciowe w coraz bardziej zdigitalizowanym środowisku operacyjnym umożliwiają łączenie OTOBO z innymi systemami i usługami. Zapewnienie efektywnej i bezpiecznej komunikacji oznacza zatem precyzyjne skonfigurowanie ustawień usług sieciowych z wyprzedzeniem. Poniżej przedstawiono podstawy ustawień usług sieciowych w OTOBO w bardziej szczegółowy sposób, aby zapewnić bardziej kompleksowy przewodnik.

Ogólne Ustawienia Interfejsów

• Nazwa*

  • Nazwa jednoznacznie identyfikuje usługę sieciową w ramach OTOBO. Ważne jest, aby wybrać jasną i opisową nazwę, która odzwierciedla funkcję lub partnera, z którym następuje interakcja.

• Opis

  • Rozszerzony komentarz, który szczegółowo opisuje cel i funkcjonalność usługi sieciowej. Ułatwia to przejrzystość i utrzymanie.

• System Zdalny

  • Umożliwia określenie nazwy systemu zewnętrznego, z którym OTOBO wchodzi w interakcję.

• Próg Debugowania

  • Wybierz, jak szczegółowe ma być logowanie komunikacji. Ustawienia wahają się od Debug (najbardziej szczegółowe logowanie) do Błąd (tylko komunikaty o błędach).

• Ważność

  • Określa, czy usługa sieciowa jest aktywowana (ważna) czy dezaktywowana (nieprawidłowa, tymczasowo nieprawidłowa). Tylko ważne usługi sieciowe są wykonywane przez OTOBO.

Transport Sieciowy - SOAP lub REST

Dla implementacji integracji z innymi systemami dostępne są różne protokoły. Wybór transportu sieciowego jest tutaj fundamentalny:

• Transport Sieciowy

  • Wybierz między HTTP::REST a HTTP::SOAP. Protokoły te definiują, jak odbywa się transfer danych między systemem obsługi zgłoszeń OTOBO a podłączonym systemem.

• Dodaj Operację

  • Umożliwia zdefiniowanie specyficznych akcji, zwanych operacjami, dla usługi sieciowej. Można wybierać spośród wielu predefiniowanych operacji, takich jak na przykład Ticket::TicketCreate do tworzenia zgłoszeń.

Tworzenie Zgłoszenia przez REST

Praktyczny przykład ilustruje wartość usług sieciowych w OTOBO. Za pomocą protokołu HTTP::REST można skonfigurować operację Ticket::TicketCreate. Zdefiniowane trasy umożliwiają systemom zewnętrznym tworzenie zgłoszeń w OTOBO za pomocą żądań HTTP POST. Pozwala to na realizację nowych wymiarów automatyzacji i integracji, co może znacząco zwiększyć efektywność procesów i zadowolenie klientów.

Usługi Sieciowe OTOBO AI Klasyfikacja Zgłoszeń (ATC)

Aby korzystać z AI Klasyfikacji Zgłoszeń (ATC) w OTOBO, należy odpowiednio skonfigurować ustawienia usług sieciowych. ATC wymaga dostępu przez REST API do danych zgłoszeń w celu przeprowadzenia klasyfikacji. OTOBO AI Klasyfikacja Zgłoszeń

Wskazówka Bezpieczeństwa

Należy pamiętać, że podczas eksportu ustawień usług sieciowych hasła mogą zostać wyeksportowane w postaci czystego tekstu. Dlatego kluczowe jest bezpieczne obchodzenie się z poufnymi informacjami i przestrzeganie przepisów bezpieczeństwa.

Efektywne wykorzystanie usług sieciowych w OTOBO pozwala firmom na bardziej inteligentne i elastyczne kształtowanie swoich przepływów pracy. Poprzez precyzyjną konfigurację ustawień usług sieciowych tworzona jest solidna podstawa, która pozwala na bezproblemową integrację OTOBO z cyfrowym ekosystemem firmy. Ustawienia i Operacje Usług Sieciowych w OTOBO

Integracja systemów zewnętrznych z OTOBO za pomocą usług sieciowych jest kluczowym elementem zapewniającym efektywne zarządzanie zgłoszeniami. Integracja ta jest możliwa dzięki zdefiniowaniu różnych operacji, które mogą wykonywać określone akcje w ramach cyklu życia zgłoszenia. Istotną częścią tej integracji jest zrozumienie niezbędnych atrybutów dla każdej operacji oraz wykorzystanie standardu XLST do transferu danych.

Wymagane Atrybuty dla Operacji Interfejsów

Dla podstawowych operacji na zgłoszeniach w OTOBO wymagane są specyficzne atrybuty. Oto linki do oficjalnych zasobów, które szczegółowo opisują atrybuty wymagane do tworzenia, pobierania, aktualizowania, wyszukiwania i pobierania historii zgłoszeń:

• TicketCreate : Specyfikacja TicketCreate
  • TicketGet : Specyfikacja TicketGet
  • TicketUpdate : Specyfikacja TicketUpdate
  • TicketSearch : Specyfikacja TicketSearch
  • TicketHistoryGet : Specyfikacja TicketHistoryGet

Dokumentacja ta umożliwia programistom precyzyjne wprowadzanie zmian i zapewnienie, że wszystkie zapytania zawierają niezbędne informacje do pomyślnego przetworzenia.

Wykorzystanie Standardu XLST do Transferu Danych

Transformacja XLST jest potężną techniką do przesyłania przychodzących danych z zapytań usług sieciowych do formatu przetwarzalnego przez OTOBO. Tworząc na przykład dynamiczne pole "RemoteTicketID" dla zgłoszeń, można efektywnie przechowywać i dalej przetwarzać przychodzące dane:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:template match="/">
        <Ticket>
            <DynamicField>
                <Name>RemoteTicketID</Name>
                <Value>
                    <xsl:value-of select="incidentID"/>
                </Value>
            </DynamicField>
        </Ticket>
    </xsl:template>
</xsl:stylesheet>

Ten przykład pokazuje, jak można przekształcić wartość przychodzącego atrybutu incidentID do dynamicznego pola zgłoszenia o nazwie RemoteTicketID.

Ustawienia Usług Sieciowych: Wnioskodawca (Requester)

Do implementacji procedur usług sieciowych jako wnioskodawca, OTOBO oferuje wybór między protokołami HTTP:: REST i HTTP::SOAP. Wybór transportu sieciowego jest tutaj kluczowy, aby zapewnić prawidłowe połączenie z systemem zewnętrznym. Po wybraniu transportu należy zapisać konfigurację i dostosować ją do specyficznych wymagań.

Utworzenie modułu obsługi błędów jest również ważnym krokiem w celu zagwarantowania solidnej komunikacji. OTOBO umożliwia implementację i konfigurację specyficznych modułów do tego celu.

Zakończenie i Dalsze Kroki

Dostarczając wszechstronnie konfigurowalne API dla usług sieciowych, OTOBO otwiera świat możliwości integracji i automatyzacji procesów zarządzania zgłoszeniami. Poprzez dostarczanie dokładnych specyfikacji i wykorzystanie standardów takich jak XLST do manipulacji danymi, OTOBO oferuje swoim użytkownikom elastyczną podstawę do rozszerzania swoich systemów zgłoszeń zgodnie z ich specyficznymi wymaganiami biznesowymi.

Niezależnie od tego, czy jako dostawca, czy wnioskodawca, precyzyjne przetwarzanie ustawień usług sieciowych zapewnia bezproblemową i efektywną komunikację z systemami i usługami zewnętrznymi.