OTOBO / Znuny Web Services - REST API

Introduzione all'integrazione di interfacce esterne

INFO

Questo articolo sui web service ha una grande sovrapposizione con l'articolo REST API REST API.

In un mondo sempre più connesso, i sistemi di gestione dei ticket devono essere in grado di rispondere automaticamente alle richieste di altri sistemi e inviare richieste o dati a servizi esterni. OTOBO, il potente sistema di gestione dei ticket open source, affronta questa sfida con la sua interfaccia generica. Consente agli amministratori di creare web service per vari compiti senza richiedere una profonda conoscenza della programmazione. OTOBO supporta la comunicazione via protocollo REST e SOAP, consentendo un'integrazione senza soluzione di continuità con:

• Sistemi CRM
• Sistemi di gestione dei progetti
• Sistemi di gestione dei documenti
• E molte altre applicazioni

Un web service funge da collegamento tra OTOBO e sistemi esterni. Le operazioni e invoker definiscono la direzione della comunicazione, mentre mapping e trasporto stabiliscono come vengono trasferiti e interpretati i dati. Con OTOBO è possibile configurare web service per eseguire azioni interne, avviare richieste su sistemi remoti, gestire la conversione dei dati tra i sistemi e stabilire il protocollo di comunicazione.

L'accesso ai web service è disponibile nel modulo Web Services del gruppo Processi e automazione. Un'installazione fresca di OTOBO non contiene web service preconfigurati di default. La documentazione illustra come creare, modificare, eliminare, clonare, esportare e importare web service, nonché l'uso dello strumento di debug. Per questo, si rimanda ai passaggi descritti nella documentazione ufficiale di amministrazione di OTOBO.

Implementazione delle interfacce

L'implementazione dei web service in OTOBO consente un'integrazione flessibile e dinamica dei processi aziendali con numerosi strumenti e sistemi esterni. La generazione e l'utilizzo di questi servizi aumenta l'efficienza riducendo gli interventi manuali e abbreviando i tempi di risposta alle richieste dei clienti. Inoltre, la versatilità dell'interfaccia generica garantisce che OTOBO sia estensibile quasi senza limiti e si integri perfettamente nelle esistenti infrastrutture IT.

Sicurezza e configurazione

Per quanto riguarda la configurazione e la sicurezza dei web service, è importante notare che durante l'esportazione, tutte le password memorizzate vengono esportate in chiaro. La custodia e la gestione delle password devono quindi essere trattate con particolare cura.

Per informazioni dettagliate sulla configurazione interna del sistema, come ad esempio le opzioni di configurazione della cache e dei moduli frontend, si consiglia di consultare il documento otobo-system-configuration.txt. Questa risorsa offre una panoramica completa di tutte le opzioni di configurazione.

Documentazione delle connessioni

I web service offrono, in un ambiente operativo sempre più digitalizzato, la possibilità di collegare OTOBO ad altri sistemi e servizi. Garantire una comunicazione efficiente e sicura significa quindi configurare con precisione le impostazioni dei web service in anticipo. Di seguito vengono illustrate le basi delle impostazioni per i web service in OTOBO in modo più dettagliato, per offrire una guida operativa più completa.

Impostazioni generali dell'interfaccia

• Nome*

  • Il nome identifica univocamente il web service all'interno di OTOBO. È importante scegliere un nome chiaro e descrittivo che rifletta la funzione o il partner con cui si interagisce.

• Descrizione

  • Un commento esteso che descrive lo scopo e la funzionalità del web service in dettaglio. Ciò facilita la comprensione e la manutenzione.

• Sistema remoto

  • Consente di specificare il nome del sistema esterno con cui OTOBO interagisce.

• Soglia di debug

  • Selezionare quanto dettagliata deve essere la registrazione della comunicazione. Le impostazioni vanno da Debug (registrazione più dettagliata) a Errore (solo messaggi di errore).

• Validità

  • Determina se il web service è attivato (valido) o disattivato (non valido, temporaneamente non valido). Solo i web service validi vengono eseguiti da OTOBO.

Trasporto di rete - SOAP o REST

Per l'implementazione dell'integrazione con altri sistemi, sono disponibili diversi protocolli. La scelta del trasporto di rete è fondamentale:

• Trasporto di rete

  • Selezionare tra HTTP::REST e HTTP::SOAP. Questi protocolli definiscono come avviene il trasferimento dei dati tra il sistema di ticket OTOBO e il sistema connesso.

• Aggiungi operazione

  • Consente di definire azioni specifiche, note come operazioni, per il web service. È possibile scegliere tra una varietà di operazioni predefinite, come ad esempio Ticket::TicketCreate per la creazione di ticket.

Creazione di un ticket via REST

Un esempio pratico illustra il valore dei web service in OTOBO. Utilizzando il protocollo HTTP::REST, è possibile configurare l'operazione Ticket::TicketCreate. Le rotte definite consentono ai sistemi esterni di creare ticket in OTOBO utilizzando richieste HTTP-POST. Ciò realizza nuove dimensioni di automazione e integrazione, aumentando notevolmente l'efficienza dei processi e la soddisfazione del cliente.

Web service OTOBO AI classificazione dei ticket (ATC)

Per utilizzare la classificazione dei ticket AI (ATC) in OTOBO, è necessario configurare le impostazioni del web service di conseguenza. L'ATC richiede l'accesso alla REST API per accedere ai dati del ticket e eseguire la classificazione. Classificazione dei ticket OTOBO

Avviso di sicurezza

È importante notare che durante l'esportazione delle impostazioni del web service, le password possono essere esportate in chiaro. È essenziale trattare le informazioni sensibili con cura e rispettare le norme di sicurezza.

L'utilizzo efficace dei web service in OTOBO consente alle aziende di progettare i propri flussi di lavoro in modo più intelligente e agile. Configurando con precisione le impostazioni del web service, si crea una solida base che consente di integrare OTOBO senza soluzione di continuità nell'ecosistema digitale dell'azienda. Impostazioni e operazioni del web service in OTOBO

L'integrazione dei sistemi esterni con OTOBO tramite web service è un componente essenziale per garantire una gestione efficiente dei ticket. Questa integrazione viene resa possibile dalla definizione di diverse operazioni che possono eseguire azioni specifiche nel ciclo di vita del ticket. Una parte fondamentale di questa integrazione è la comprensione degli attributi necessari per ogni operazione, nonché l'utilizzo dello standard XLST per il trasferimento dei dati.

Attributi richiesti per le operazioni dell'interfaccia

Per le operazioni di base dei ticket in [OTOBO](../../index.md] sono richiesti attributi specifici. Ecco i collegamenti alle risorse ufficiali che descrivono in dettaglio gli attributi necessari per la creazione, il recupero, l'aggiornamento, la ricerca e il recupero della storia dei ticket:

• TicketCreate : Specifiche di TicketCreate
  • TicketGet : Specifiche di TicketGet
  • TicketUpdate : Specifiche di TicketUpdate
  • TicketSearch : Specifiche di TicketSearch
  • TicketHistoryGet : Specifiche di TicketHistoryGet

Questa documentazione consente agli sviluppatori di apportare modifiche precise e di assicurare che tutte le richieste contengano le informazioni necessarie per essere elaborate con successo.

Utilizzo dello standard XLST per il trasferimento dei dati

La trasformazione XLST è una tecnica potente per trasferire i dati in ingresso dalle richieste del web service in una forma che OTOBO possa elaborare. Creando ad esempio un campo dinamico "RemoteTicketID" per i ticket, è possibile archiviare e ulteriormente elaborare i dati in ingresso in modo efficiente:

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

Questo esempio mostra come trasformare il valore dell'attributo incidentID in ingresso in un campo dinamico del ticket denominato RemoteTicketID.

Impostazioni del web service: richiedente (Requester)

Per l'implementazione delle procedure del web service come richiedente, OTOBO offre la scelta tra i protocolli HTTP::REST e HTTP::SOAP. La scelta del trasporto di rete è fondamentale per garantire una connessione corretta con il sistema esterno. Dopo la selezione del trasporto, la configurazione deve essere salvata e adattata in base alle esigenze specifiche.

La creazione di un modulo di gestione degli errori è un passaggio importante per garantire una comunicazione robusta. OTOBO consente di implementare e configurare moduli specifici per questo scopo.

Conclusione e passi successivi

Fornendo un'API per web service altamente configurabile, OTOBO apre un mondo di possibilità per l'integrazione e l'automazione dei processi di gestione dei ticket. Offrendo specifiche precise e utilizzando standard come XLST per la manipolazione dei dati, OTOBO fornisce ai suoi utenti una base flessibile per estendere i propri sistemi di ticketing in linea con le esigenze aziendali specifiche.

Sia come fornitore che come richiedente, l'elaborazione precisa delle impostazioni del web service garantisce una comunicazione senza soluzione di continuità ed efficiente con sistemi e servizi esterni.