OTOBO / Znuny Web Services - REST API

Introductie tot de integratie van externe interfaces

INFO

Dit artikel over webservices heeft een grote overlap met het artikel REST API REST API.

In een wereldwijd verbonden wereld moeten ticketsystemen in staat zijn om geautomatiseerd te reageren op verzoeken van andere systemen en om verzoeken of gegevens naar externe services te kunnen sturen. OTOBO, het krachtige open-source ticketsysteem, pakt deze uitdaging aan met zijn Generieke Interface. Het stelt beheerders in staat om, zonder diepgaande programmeerkennis, webservices te creëren voor diverse taken. OTOBO ondersteunt communicatie via REST- en SOAP-protocollen, en maakt naadloze integratie mogelijk met:

• CRM-systemen
• Projectmanagement systemen
• Document management systemen
• en vele andere applicaties

Een webservice fungeert als schakel tussen OTOBO en externe systemen. Hierbij definiëren Operaties en Invoker de richting van de communicatie, terwijl Mapping en Transport bepalen hoe gegevens worden overgedragen en geïnterpreteerd. Met OTOBO kunt u webservices configureren om intern acties uit te voeren, verzoeken op externe systemen te initiëren, gegevensconversies tussen systemen te beheren en het communicatieprotocol te specificeren.

De toegang tot de webservices is te vinden in de module Web Services van de groep Processen & Automatisering. Een verse installatie van OTOBO bevat standaard geen vooraf geconfigureerde webservices. Hieronder illustreert de documentatie hoe webservices kunnen worden aangemaakt, bewerkt, verwijderd, gekloond, geëxporteerd en geïmporteerd, evenals het gebruik van de debugger tool. Hiervoor wordt verwezen naar de stappen die gedetailleerd worden beschreven in de officiële OTOBO-beheerdersdocumentatie.

Implementatie van de Interfaces

De implementatie van webservices in OTOBO maakt een flexibele en dynamische integratie van uw bedrijfsprocessen met tal van externe tools en systemen mogelijk. Door het genereren en gebruiken van deze services wordt de efficiëntie verhoogd door handmatige ingrepen te verminderen en de reactietijden op klantverzoeken te verkorten. Bovendien zorgt de veelzijdigheid van de generieke interface ervoor dat OTOBO vrijwel onbeperkt uitbreidbaar is en zich daardoor perfect voegt in bestaande IT-landschappen.

Beveiliging en Configuratie

Wat betreft de configuratie en beveiliging van webservices is het belangrijk op te merken dat bij een export alle opgeslagen wachtwoorden in platte tekst worden meegeëxporteerd. De opslag en het beheer van wachtwoorden moeten daarom met bijzondere zorg worden behandeld.

Voor gedetailleerde informatie over de systeeminterne configuratie, zoals de configuratiemogelijkheden van cache en frontend-modules, raden we aan het document otobo-system-configuration.txt te raadplegen. Deze bron biedt een uitgebreid overzicht van alle configuratieopties.

Documentatie van de Koppelingen

Webservices bieden in een steeds meer gedigitaliseerde werkomgeving de mogelijkheid om OTOBO te koppelen met andere systemen en services. Het waarborgen van efficiënte en veilige communicatie betekent daarom webservice-instellingen vooraf nauwkeurig configureren. Hieronder worden de basisprincipes van de instellingen voor webservices in OTOBO gedetailleerder uitgelegd om u een uitgebreidere handleiding te bieden.

Algemene Interface Instellingen

• Naam*

  • De naam identificeert de webservice uniek binnen OTOBO. Het is belangrijk om een duidelijke en beschrijvende naam te kiezen die de functie of de partner weerspiegelt waarmee wordt geïnteracteerd.

• Beschrijving

  • Een uitgebreid commentaar dat het doel en de functionaliteit van de webservice gedetailleerd beschrijft. Dit vergemakkelijkt het overzicht en onderhoud.

• Extern Systeem

  • Maakt het mogelijk om de naam van het externe systeem vast te leggen waarmee OTOBO interacteert.

• Debug-drempelwaarde

  • Kies hoe gedetailleerd de logging van de communicatie moet zijn. De instellingen variëren van Debug (meest gedetailleerde logging) tot Fout (alleen foutmeldingen).

• Geldigheid

  • Bepaalt of de webservice is ingeschakeld (geldig) of uitgeschakeld (ongeldig, tijdelijk ongeldig). Alleen geldige webservices worden door OTOBO uitgevoerd.

Netwerktransport - SOAP of REST

Voor de implementatie van de integratie met andere systemen zijn verschillende protocollen beschikbaar. Hierbij is de keuze van het netwerktransport fundamenteel:

• Netwerktransport

  • Kies tussen HTTP::REST en HTTP::SOAP. Deze protocollen bepalen hoe de gegevensoverdracht tussen het OTOBO ticketsysteem en het verbonden systeem plaatsvindt.

• Operatie Toevoegen

  • Maakt het mogelijk om specifieke acties, zogenaamde operaties, voor de webservice te definiëren. Hierbij kunt u kiezen uit een verscheidenheid aan vooraf gedefinieerde operaties, zoals bijvoorbeeld Ticket::TicketCreate voor het aanmaken van tickets.

Aanmaken van een Ticket via REST

Een praktisch voorbeeld verduidelijkt de waarde van webservices in OTOBO. Via het HTTP::REST-protocol kan de operatie Ticket::TicketCreate worden ingesteld. De gedefinieerde routes maken het voor externe systemen mogelijk om, met behulp van HTTP-POST-verzoeken, tickets in OTOBO aan te maken. Hierdoor worden nieuwe dimensies van automatisering en integratie gerealiseerd, wat de procesefficiëntie en klanttevredenheid aanzienlijk kan verhogen.

Webservices OTOBO AI Ticket Classificatie (ATC)

Voor het gebruik van de AI Ticket Classificatie (ATC) in OTOBO, moet u de webservice-instellingen dienovereenkomstig configureren. ATC heeft toegang nodig via de REST API om toegang te krijgen tot de ticketgegevens en de classificatie uit te voeren. OTOBO Ticket Classificatie

Veiligheidswaarschuwing

Houd er rekening mee dat bij exports van webservice-instellingen wachtwoorden in platte tekst kunnen worden geëxporteerd. Het is daarom essentieel om gevoelige informatie beschermd te behandelen en veiligheidsvoorschriften na te leven.

Het effectieve gebruik van webservices in OTOBO stelt bedrijven in staat om hun workflows intelligenter en flexibeler te maken. Door de nauwkeurige configuratie van de webservice-instellingen wordt een solide basis gelegd die het mogelijk maakt om OTOBO naadloos te integreren in het digitale ecosysteem van een bedrijf. Webservice-instellingen en -operaties in OTOBO

De integratie van externe systemen met OTOBO via webservices is een essentieel onderdeel om een efficiënt ticketbeheer te garanderen. Deze integratie wordt mogelijk gemaakt door de definitie van verschillende operaties die specifieke acties binnen de ticketlevenscyclus kunnen uitvoeren. Een belangrijk onderdeel van deze integratie is het begrijpen van de benodigde attributen voor elke operatie en het gebruik van de XLST-standaard voor de gegevensoverdracht.

Vereiste Attributen voor de Interface Operaties

Voor de basis ticketoperaties in OTOBO zijn specifieke attributen vereist. Hier zijn links naar de officiële bronnen die de attributen die nodig zijn voor het aanmaken, ophalen, bijwerken, zoeken en ophalen van de geschiedenis van tickets gedetailleerd beschrijven:

• TicketCreate : TicketCreate Specificatie
  • TicketGet : TicketGet Specificatie
  • TicketUpdate : TicketUpdate Specificatie
  • TicketSearch : TicketSearch Specificatie
  • TicketHistoryGet : TicketHistoryGet Specificatie

Deze documentatie stelt ontwikkelaars in staat om aanpassingen nauwkeurig door te voeren en ervoor te zorgen dat alle verzoeken de benodigde informatie bevatten om succesvol te worden verwerkt.

Gebruik van de XLST-standaard voor Gegevensoverdracht

De XLST-transformatie is een krachtige techniek om inkomende gegevens van webservice-verzoeken over te zetten naar een vorm die door OTOBO kan worden verwerkt. Door bijvoorbeeld een dynamisch veld "RemoteTicketID" aan te maken voor tickets, kunt u inkomende gegevens efficiënt opslaan en verder verwerken:

<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>

Dit voorbeeld toont hoe u de waarde van het inkomende attribuut incidentID kunt transformeren naar een ticket-dynamisch veld met de naam RemoteTicketID.

Webservice-instellingen: Aanvrager (Requester)

Voor de implementatie van webservice-procedures als aanvrager biedt OTOBO de keuze tussen de protocollen HTTP:: REST en HTTP::SOAP. Hierbij is de keuze van het netwerktransport essentieel om een correcte verbinding met het externe systeem te garanderen. Na selectie van het transport moet de configuratie worden opgeslagen en dienovereenkomstig de specifieke vereisten worden aangepast.

Het opzetten van een foutafhandelingsmodule is eveneens een belangrijke stap om een robuuste communicatie te garanderen. OTOBO maakt het mogelijk om hiervoor specifieke modules te implementeren en te configureren.

Afronding en Volgende Stappen

Door OTOBO een veelzijdig configureerbare API voor webservices te laten bieden, opent het een wereld aan mogelijkheden voor de integratie en automatisering van ticketmanagementprocessen. Door nauwkeurige specificaties te leveren en standaarden zoals XLST te gebruiken voor datamanipulatie, biedt OTOBO zijn gebruikers een flexibele basis voor de uitbreiding van hun ticketingsystemen in lijn met hun specifieke zakelijke vereisten.

Of het nu als aanbieder of aanvrager is, de nauwkeurige verwerking van webservice-instellingen garandeert een naadloze en efficiënte communicatie met externe systemen en diensten.