Web Services OTOBO - REST API

Introduction à l’intégration d’interfaces externes

::: info

Cet article sur les Web Services présente de nombreuses similitudes avec l’article REST API REST API.

:::

Dans un monde globalement connecté, les systèmes de tickets doivent être capables de réagir de manière automatisée aux demandes d’autres systèmes, ainsi que d’envoyer des demandes ou des données à des services externes. OTOBO, le puissant système de tickets open source, relève ce défi grâce à son Generic Interface. Il permet aux administrateurs, sans connaissances approfondies en programmation, de créer des services Web pour des tâches variées. OTOBO prend en charge la communication via les protocoles REST et SOAP, permettant une intégration transparente avec :

Systèmes CRM
Systèmes de gestion de projet
Systèmes de gestion documentaire
et bien d’autres applications

Un service Web agit comme un lien entre OTOBO et les systèmes externes. Les Opérations et les Invokers définissent la direction de la communication, tandis que le Mapping et le Transport déterminent comment les données sont transmises et interprétées. Avec OTOBO, vous pouvez configurer des services Web pour exécuter des actions en interne, initier des demandes sur des systèmes distants, gérer les conversions de données entre les systèmes et définir le protocole de communication.

L’accès aux Web Services se trouve dans le module Web Services du groupe Processus & Automatisation. Une installation fraîche de OTOBO ne contient par défaut aucun Web Service préconfiguré. La documentation suivante illustre comment les services Web peuvent être créés, modifiés, supprimés, clonés, exportés et importés, ainsi que l’utilisation de l’outil Debugger. À cet effet, veuillez vous référer aux étapes décrites en détail dans la documentation d’administration officielle d’OTOBO.

Implémentation des interfaces

L’implémentation de Web Services dans OTOBO permet une intégration flexible et dynamique de vos processus métier avec de nombreux outils et systèmes externes. Grâce à la génération et à l’utilisation de ces Services, l’efficacité est accrue en réduisant les interventions manuelles et en raccourcissant les temps de réponse aux demandes des clients. De plus, la polyvalence du Generic Interface garantit que OTOBO est extensible de manière quasi illimitée et s’intègre ainsi parfaitement dans les paysages informatiques existants.

Sécurité et configuration

Concernant la configuration et la sécurité des services Web, il est important de noter que lors d’une exportation, tous les mots de passe enregistrés sont exportés en texte clair. La conservation et la manipulation des mots de passe doivent donc être traitées avec une attention particulière.

Pour des informations détaillées sur la configuration interne du système, comme par exemple les options de configuration du Cache et des modules Frontend, nous recommandons de consulter le document otobo-system-configuration.txt. Cette source offre un aperçu complet de toutes les options de configuration.

Documentation des connexions

Dans un environnement opérationnel de plus en plus numérisé, les services Web offrent la possibilité de relier OTOBO à d’autres systèmes et services. Garantir une communication efficace et sécurisée signifie donc configurer précisément les paramètres des services Web en amont. Les bases des paramètres pour les services Web dans OTOBO sont expliquées plus en détail ci-dessous afin de vous offrir un guide d’utilisation plus complet.

Paramètres généraux de l’interface

Nom*
- Le nom identifie le service Web de manière unique au sein d’OTOBO. Il est important de choisir un nom clair et descriptif qui reflète la fonction ou le partenaire avec lequel l’interaction a lieu.
Description
- Un commentaire étendu qui détaille l’objectif et la fonctionnalité du service Web. Cela facilite la clarté et la maintenabilité.
Système distant
- Permet de définir le nom du système externe avec lequel OTOBO interagit.
Seuil de débogage
- Choisissez le niveau de détail de la journalisation de la communication. Les paramètres vont de Debug (journalisation la plus détaillée) à Erreur (uniquement les messages d’erreur).
Validité
- Détermine si le service Web est activé (valide) ou désactivé (invalide, temporairement invalide). Seuls les services Web valides sont exécutés par OTOBO.

Transport réseau - SOAP ou REST

Pour l’implémentation de l’intégration avec d’autres systèmes, différents protocoles sont disponibles. Le choix du transport réseau est ici fondamental :

Transport réseau
- Choisissez entre HTTP::REST et HTTP::SOAP. Ces protocoles définissent comment le transfert de données s’effectue entre le système de tickets OTOBO et le système connecté.
Ajouter une opération
- Permet de définir des actions spécifiques, appelées opérations, pour le service Web. Vous pouvez choisir parmi une multitude d’opérations prédéfinies, comme par exemple Ticket::TicketCreate pour la création de tickets.

Création d’un ticket via REST

Un exemple pratique illustre la valeur des services Web dans OTOBO. Via le protocole HTTP::REST, l’opération Ticket::TicketCreate peut être configurée. Les routes définies permettent aux systèmes externes de créer des tickets dans OTOBO à l’aide de requêtes HTTP-POST. Cela permet de réaliser de nouvelles dimensions d’automatisation et d’intégration, ce qui peut augmenter considérablement l’efficacité des processus et la satisfaction des clients.

Web Services OTOBO AI Ticket Classification (ATC)

Pour l’utilisation de l’AI Ticket Classification (ATC) dans OTOBO, vous devez configurer les paramètres des services Web en conséquence. ATC nécessite un accès via la REST API pour accéder aux données des tickets et effectuer la classification. Classification de tickets OTOBO

Note de sécurité

Veuillez noter que lors de l’exportation des paramètres des services Web, les mots de passe peuvent être exportés en texte clair. Il est donc essentiel de traiter les informations sensibles de manière protégée et de respecter les règles de sécurité.

L’utilisation efficace des services Web dans OTOBO permet aux entreprises de rendre leurs flux de travail plus intelligents et plus agiles. Grâce à la configuration précise des paramètres des services Web, une base solide est créée, permettant d’intégrer OTOBO de manière transparente dans l’écosystème numérique d’une entreprise. Paramètres et opérations des services Web dans OTOBO

L’intégration de systèmes externes avec OTOBO via des services Web est un élément essentiel pour garantir une gestion efficace des tickets. Cette intégration est rendue possible par la définition de différentes opérations pouvant exécuter des actions spécifiques dans le cadre du cycle de vie du ticket. Une partie essentielle de cette intégration est la compréhension des attributs nécessaires pour chaque opération ainsi que l’utilisation du standard XSLT pour le transfert de données.

Attributs requis pour les opérations d’interface

Pour les opérations de base sur les tickets dans OTOBO, des attributs spécifiques sont requis. Voici des liens vers les ressources officielles qui décrivent en détail les attributs nécessaires à la création, la récupération, la mise à jour, la recherche et l’obtention de l’historique des tickets :

TicketCreate : Spécification TicketCreate
- TicketGet : Spécification TicketGet
- TicketUpdate : Spécification TicketUpdate
- TicketSearch : Spécification TicketSearch
- TicketHistoryGet : Spécification TicketHistoryGet

Cette documentation permet aux développeurs d’effectuer des ajustements précis et de s’assurer que toutes les demandes contiennent les informations nécessaires pour être traitées avec succès.

Utilisation du standard XSLT pour le transfert de données

La transformation XSLT est une technique puissante pour transférer les données entrantes des demandes de services Web sous une forme traitable par OTOBO. En créant par exemple un champ dynamique “RemoteTicketID” pour les tickets, vous pouvez stocker et traiter efficacement les données entrantes :

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

Cet exemple montre comment transformer la valeur de l’attribut entrant incidentID en un champ dynamique de ticket nommé RemoteTicketID.

Paramètres des services Web : Demandeur (Requester)

Pour l’implémentation des procédures de services Web en tant que demandeur, OTOBO propose le choix entre les protocoles HTTP::REST et HTTP::SOAP. Le choix du transport réseau est ici élémentaire pour assurer une connexion correcte avec le système externe. Après avoir sélectionné le transport, la configuration doit être enregistrée et adaptée aux exigences spécifiques.

La mise en place d’un module de gestion des erreurs est également une étape importante pour garantir une communication robuste. OTOBO permet d’implémenter et de configurer des modules spécifiques à cet effet.

Conclusion et étapes suivantes

En fournissant une API polyvalente et configurable pour les services Web, OTOBO ouvre un monde de possibilités pour l’intégration et l’automatisation des processus de gestion des tickets. En fournissant des spécifications précises et en utilisant des standards comme XSLT pour la manipulation des données, OTOBO offre à ses utilisateurs une base flexible pour l’extension de leurs systèmes de ticketing en accord avec leurs besoins métier spécifiques.

Qu’il s’agisse d’un fournisseur ou d’un demandeur, le traitement précis des paramètres des services Web assure une communication transparente et efficace avec les systèmes et services externes.