OTOBO / Znuny Webservices - REST API

Inleiding in de integratie van externe interfaces

INFO

Dit webservices-artikel 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 verzoeken of gegevens naar externe diensten te verzenden. OTOBO, het krachtige open-source-ticketsysteem, komt deze uitdaging tegemoet met zijn generische interface. Het stelt beheerders in staat om, zonder diepgaande programmeerkennis, webservices voor diverse taken te maken. OTOBO ondersteunt de communicatie via REST- en SOAP-protocol, waardoor een naadloze integratie mogelijk is met:

• CRM-systemen
• projectmanagementsystemen
• documentmanagementsystemen
• en vele andere toepassingen

Een webservice fungeert als verbinding tussen OTOBO en externe systemen. Hierbij definiëren operaties en aanroeper de richting van de communicatie, terwijl toewijzing en transport bepalen hoe gegevens worden overgedragen en geïnterpreteerd. Met OTOBO kunnen webservices worden geconfigureerd om interne acties uit te voeren, verzoeken op remote-systemen te initiëren, gegevensconversies tussen systemen te beheren en het communicatieprotocol vast te stellen.

De toegang tot de webservices is te vinden in het module Webservices van de groep Proces & Automatisering. Een verse installatie van OTOBO bevat standaard geen vooraf geconfigureerde webservices. De documentatie illustreert hoe webservices kunnen worden gemaakt, bewerkt, verwijderd, gekloond, geëxporteerd en geïmporteerd, evenals het gebruik van het debuggereedschap. Hiervoor wordt verwezen naar de stappen die in de officiële OTOBO-beheerdocumentatie in detail worden beschreven.

Implementatie van interfaces

De implementatie van webservices in OTOBO maakt een flexibele en dynamische integratie van uw bedrijfsprocessen met talloze externe tools en systemen mogelijk. Door het genereren en gebruiken van deze services wordt de efficiëntie verhoogd, door het reduceren van handmatige ingrepen en het verkorten van de reactietijden op klantverzoeken. Bovendien zorgt de veelzijdigheid van het generische interface ervoor dat OTOBO nagenoeg onbeperkt uitbreidbaar is en zich zo perfect in bestaande IT-landschappen integreert.

Beveiliging en configuratie

Met betrekking tot de configuratie en beveiliging van webservices is het belangrijk om te noteren dat bij een export alle opgeslagen wachtwoorden in plaintext worden geëxporteerd. De opslag en het gebruik 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 om het document otobo-systeemconfiguratie.txt te raadplegen. Deze bron biedt een uitgebreid overzicht van alle configuratieopties.

Documentatie van aansluitingen

Webservices bieden in een steeds verder gedigitaliseerde bedrijfsomgeving de mogelijkheid om OTOBO met andere systemen en diensten te verbinden. Het waarborgen van een efficiënte en veilige communicatie betekent daarom, webservices-instellingen van tevoren nauwkeurig te configureren. In het volgende worden de basisbeginselen 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 uitgebreide opmerking, die het doel en de functionaliteit van de webservice in detail beschrijft. Dit vergemakkelijkt de overzichtelijkheid en onderhoud.

• Extern systeem

  • Maakt het mogelijk om de naam van het externe systeem vast te stellen waarmee OTOBO communiceert.

• Debug-drempel

  • 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 geactiveerd (geldig) of gedeactiveerd (ongeldig, tijdelijk onbruikbaar) is. 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 definiëren 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 kunnen u uit een verscheidenheid aan vooraf gedefinieerde operaties kiezen, zoals Ticket::TicketCreate voor het maken 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 mogelijk voor externe systemen om, met behulp van HTTP-POST-verzoeken, tickets in OTOBO aan te maken. Hierdoor worden nieuwe dimensies van automatisering en integratie gerealiseerd, wat procesefficiëntie en klanttevredenheid aanzienlijk kan verhogen.

Webservices OTOBO AI Ticketclassificatie (ATC)

Voor het gebruik van de AI Ticketclassificatie (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

Beveiligingswaarschuwing

Let op dat bij het exporteren van de webservice-instellingen wachtwoorden in plaintext kunnen worden geëxporteerd. Het is daarom essentieel om gevoelige informatie te beschermen en beveiligingsvoorschriften te volgen.

Het effectief gebruik van webservices in OTOBO maakt het mogelijk voor bedrijven om hun werkprocessen slimmer en flexibeler in te richten. Door de nauwkeurige configuratie van de webservice-instellingen wordt een solide basis gecreëerd, die het mogelijk maakt om OTOBO naadloos in het digitale ecosysteem van een bedrijf te integreren. Webservice-instellingen en -operaties in OTOBO

De integratie van externe systemen met OTOBO via webservices is een essentieel onderdeel om een efficiënt ticketmanagement te garanderen. Deze integratie wordt mogelijk gemaakt door de definitie van verschillende operaties, die specifieke acties in het kader van de ticketlevenscyclus kunnen uitvoeren. Een wezenlijk onderdeel van deze integratie is het begrip van de benodigde attributen voor elke operatie, evenals 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 voor de aanmaak, ophalen, bijwerken, zoeken en ophalen van de geschiedenis van tickets benodigde attributen in detail 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 te garanderen dat alle verzoeken de benodigde informatie bevatten om succesvol te worden verwerkt.

Gebruik van de XLST-standaard voor de gegevensoverdracht

De XLST-transformatie is een krachtige techniek om inkomende gegevens uit webservice-verzoeken om te zetten in een voor OTOBO verwerkbare vorm. Door bijvoorbeeld een dynamisch veld "RemoteTicketID" voor tickets aan te maken, kunnen inkomende gegevens efficiënt worden opgeslagen en verder verwerkt:

<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 omzetten in een ticketdynamisch veld genaamd RemoteTicketID.

Webservice-instellingen: aanvrager (requester)

Voor de implementatie van webserviceprocedures als aanvrager biedt OTOBO de keuze tussen de protocollen HTTP::REST en HTTP::SOAP. Hierbij is de keuze van het netwerktransport elementair om een ordelijke verbinding met het externe systeem te garanderen. Na de keuze van het transport moet de configuratie worden opgeslagen en dienovereenkomstig worden aangepast.

Het opzetten van een foutafhandelingsmodule is eveneens een belangrijke stap om een robuuste communicatie te garanderen. OTOBO biedt de mogelijkheid om hiervoor specifieke modules te implementeren en te configureren.

Afsluiting en verdere stappen

Door OTOBO een veelzijdig configureerbare API voor webservices te bieden, opent het een wereld van mogelijkheden voor de integratie en automatisering van ticketmanagementprocessen. Door het bieden van nauwkeurige specificaties en het gebruik van standaarden zoals XLST voor gegevensmanipulatie biedt OTOBO zijn gebruikers een flexibele basis voor het uitbreiden van hun ticketsystemen in overeenstemming met hun specifieke bedrijfsvereisten.

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