OTOBO / Znuny Usługi internetowe - REST API

Wprowadzenie do integracji zewnętrznych interfejsów

INFO

Ten artykuł o usługach internetowych ma duże pokrywanie się z artykułem REST API REST API.

W świecie zunifikowanym globalnie, systemy obsługi biletów muszą być w stanie automatycznie reagować na zapytania innych systemów oraz wysyłać zapytania lub dane do zewnętrznych usług. OTOBO, potężne oprogramowanie open-source do obsługi biletów, spełnia to wyzwanie dzięki swojemu ogólnemu interfejsowi. Umożliwia on administratorom tworzenie usług internetowych do różnych zadań bez głębokiej wiedzy programistycznej. 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 dokumentami
• i wieloma innymi aplikacjami

Usługa internetowa działa jako połączenie między OTOBO a zewnętrznymi systemami. Operacje i Invoker definiują kierunek komunikacji, podczas gdy Mapping i Transport określają, jak dane są przesyłane i interpretowane. Z OTOBO możesz konfigurować usługi internetowe, aby wykonywać akcje wewnętrzne, inicjować zapytania na systemach zdalnych, zarządzać konwersjami danych między systemami i określać protokół komunikacji.

Dostęp do usług internetowych znajduje się w module Usługi internetowe grupy Procesy i automatyzacja. Świeża instalacja OTOBO nie zawiera domyślnie prekonfigurowanych usług internetowych. Poniższa dokumentacja ilustruje, jak usługi internetowe mogą być tworzone, edytowane, usuwane, klonowane, eksportowane i importowane, a także jak używać narzędzia debugowania. W tym celu odsyłamy do kroków opisanych w oficjalnej dokumentacji administracyjnej OTOBO.

Implementacja interfejsów

Implementacja usług internetowych w OTOBO umożliwia elastyczną i dynamiczną integrację Twoich procesów biznesowych z licznymi zewnętrznymi narzędziami i systemami. Dzięki generowaniu i wykorzystaniu tych usług zwiększa się wydajność, redukując interwencje ręczne i skracając czasy odpowiedzi na zapytania klientów. Ponadto, wszechstronność ogólnego interfejsu zapewnia, że OTOBO jest prawie nieograniczone w możliwościach rozszerzania i idealnie wpasowuje się w istniejące środowiska IT.

Bezpieczeństwo i konfiguracja

W odniesieniu do konfiguracji i bezpieczeństwa usług internetowych, istotne jest, aby pamiętać, że podczas eksportu wszystkie zapisane hasła są eksportowane w postaci jawnej. Przechowywanie i obsługa haseł powinny być traktowane z najwyższą starannością.

Dla szczegółowych informacji na temat wewnętrznej konfiguracji, takiej jak możliwości konfiguracji pamięci podręcznej i modułów frontendu, zalecamy zapoznanie się z dokumentem otobo-system-configuration.txt. Ten źródło oferuje kompleksowy przegląd wszystkich opcji konfiguracyjnych.

Dokumentacja połączeń

Usługi internetowe oferują w coraz bardziej zdigitalizowanym środowisku możliwość połączenia OTOBO z innymi systemami i usługami. Zapewnienie wydajnej i bezpiecznej komunikacji oznacza, że ustawienia usług internetowych powinny być precyzyjnie skonfigurowane z wyprzedzeniem. Poniżej przedstawiamy bardziej szczegółowo podstawy ustawień dla usług internetowych w OTOBO, aby zapewnić bardziej kompleksową instrukcję.

Ogólne ustawienia interfejsu

• Nazwa*

  • Nazwa identyfikuje usługę internetową w sposób unikalny w ramach OTOBO. Ważne jest wybranie jasnej i opisowej nazwy, która odzwierciedla funkcję lub partnera, z którym wchodzi w interakcję.

• Opis

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

• System zdalny

  • Pozwala określić nazwę zewnętrznego systemu, z którym OTOBO wchodzi w interakcję.

• Próg debugowania

  • Wybierz, jak szczegółowa ma być rejestracja komunikacji. Ustawienia wahają się od debug (najbardziej szczegółowa rejestracja) do błędu (tylko komunikaty o błędach).

• Ważność

  • Określa, czy usługa internetowa jest aktywna (ważna) czy dezaktywowana (nieważna, tymczasowo nieważna). Tylko ważne usługi internetowe 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 podstawowy:

• Transport sieciowy

  • Wybierz między HTTP::REST a HTTP::SOAP. Te protokoły definiują, jak dane są przesyłane między systemem OTOBO a połączonym systemem.

• Dodaj operację

  • Pozwala zdefiniować określone akcje, tzw. operacje, dla usługi internetowej. Można wybrać spośród wielu predefiniowanych operacji, takich jak Ticket::TicketCreate do tworzenia biletów.

Tworzenie biletu za pomocą REST

Praktyczny przykład ilustruje wartość usług internetowych w OTOBO. Za pomocą protokołu HTTP::REST można skonfigurować operację Ticket::TicketCreate. Zdefiniowane trasy umożliwiają zewnętrznym systemom tworzenie biletów w OTOBO za pomocą żądań HTTP-POST. Dzięki temu realizowane są nowe wymiary automatyzacji i integracji, co znacznie zwiększa efektywność procesów i zadowolenie klientów.

Usługi OTOBO AI klasyfikacja biletów (ATC)

Dla korzystania z klasyfikacji biletów AI (ATC) w OTOBO, należy odpowiednio skonfigurować ustawienia usług internetowych. ATC wymaga dostępu przez REST API, aby uzyskać dostęp do danych biletów i przeprowadzić klasyfikację. Klasyfikacja biletów OTOBO

Wskazówka dotycząca bezpieczeństwa

Zwróć uwagę, że podczas eksportowania ustawień usług internetowych hasła mogą być eksportowane w postaci jawnej. Dlatego jest niezwykle ważne, aby traktować wrażliwe informacje z najwyższą starannością i przestrzegać wytycznych bezpieczeństwa.

Efektywne wykorzystanie usług internetowych w OTOBO umożliwia firmom inteligentniejsze i bardziej elastyczne kształtowanie swoich procesów roboczych. Dzięki precyzyjnej konfiguracji ustawień usług internetowych tworzy się solidna podstawa, która pozwala na bezproblemową integrację OTOBO z cyfrowym ekosystemem przedsiębiorstwa. Ustawienia i operacje usług internetowych w OTOBO

Integracja zewnętrznych systemów z OTOBO za pomocą usług internetowych jest istotnym elementem zapewnienia efektywnego zarządzania biletami. Ta integracja jest możliwa dzięki definicji różnych operacji, które mogą wykonywać określone akcje w ramach cyklu życia biletu. Ważnym elementem tej integracji jest zrozumienie niezbędnych atrybutów dla każdej operacji oraz wykorzystanie standardu XLST do transferu danych.

Wymagane atrybuty dla operacji interfejsu

Dla podstawowych operacji biletowych w OTOBO wymagane są określone atrybuty. Poniżej znajdują się linki do oficjalnych zasobów, które szczegółowo opisują atrybuty niezbędne do tworzenia, pobierania, aktualizacji, wyszukiwania i pobierania historii biletów:

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

Ta dokumentacja umożliwia deweloperom precyzyjne wprowadzanie zmian i zapewnienie, że wszystkie zapytania zawierają niezbędne informacje, aby zostać pomyślnie przetworzonymi.

Wykorzystanie standardu XLST do transferu danych

Transformacja XLST jest potężną techniką do konwersji danych przychodzących z żądań usług internetowych w postać, którą może przetworzyć OTOBO. Tworząc na przykład dynamiczne pole "RemoteTicketID" dla biletów, możesz wydajnie przechowywać i dalej przetwarzać dane przychodzące:

<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ść atrybutu incidentID w pole dynamiczne biletu o nazwie RemoteTicketID.

Ustawienia usług internetowych: żądający (Requester)

Dla implementacji procedur usług internetowych jako żądający, OTOBO oferuje wybór między protokołami HTTP::REST i HTTP::SOAP. Wybór transportu sieciowego jest elementarny, aby zapewnić prawidłowe połączenie z zewnętrznym systemem. Po wyborze transportu należy zapisać konfigurację i dostosować ją do konkretnych wymagań.

Ustanowienie modułu obsługi błędów jest również istotnym krokiem, aby zapewnić komunikację odporne na błędy. OTOBO umożliwia wdrożenie i skonfigurowanie specjalnych modułów w tym celu.

Podsumowanie i dalsze kroki

Dostarczając elastyczną i konfigurowalną API dla usług internetowych, OTOBO otwiera świat możliwości dla integracji i automatyzacji procesów zarządzania biletami. Poprzez dostarczanie precyzyjnych specyfikacji i wykorzystanie standardów takich jak XLST do manipulacji danymi, OTOBO oferuje swoim użytkownikom elastyczną podstawę do rozwijania systemów biletowych zgodnie z ich specyficznymi wymaganiami biznesowymi.

Nie ważne, czy jako dostawca czy żądający, precyzyjne przetwarzanie ustawień usług internetowych zapewnia bezproblemową i efektywną komunikację z zewnętrznymi systemami i usługami.