OTOBO / Znuny Web Services - REST API

Introduction à l'intégration d'interfaces externes

INFO

Cet article sur les services Web a un grand chevauchement avec l'article REST API REST API.

Dans un monde de plus en plus interconnecté, les systèmes de tickets doivent être en mesure 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, répond à ce défi avec son Interface générique. Il permet aux administrateurs, sans connaissances approfondies en programmation, de créer des services Web pour diverses tâches. OTOBO prend en charge la communication via les protocoles REST et SOAP, permettant une intégration transparente avec :

• Les systèmes de gestion de la relation client (CRM)
• Les systèmes de gestion de projet
• Les systèmes de gestion de documents
• Et de nombreuses autres applications

Un service Web sert de lien entre OTOBO et les systèmes externes. Les opérations et invokeurs définissent la direction de la communication, tandis que Mapping et 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 internes, 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 services Web se trouve dans le module Services Web du groupe Processus et automatisation. Une installation fraîche de OTOBO ne contient pas de services Web préconfigurés par défaut. La documentation suivante illustre comment créer, modifier, supprimer, cloner, exporter et importer des services Web, ainsi que l'utilisation de l'outil de débogage. Pour cela, veuillez vous référer aux étapes décrites en détail dans la documentation officielle d'administration d'OTOBO.

Implémentation des interfaces

L'implémentation des services Web 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 améliorée en réduisant les interventions manuelles et en raccourcissant les temps de réponse aux demandes des clients. De plus, la polyvalence de l'interface générique garantit que OTOBO est pratiquement extensible sans limites et s'intègre parfaitement dans les paysages IT existants.

Sécurité et configuration

En ce qui concerne la configuration et la sécurité des services Web, il est important de noter qu'à l'exportation, tous les mots de passe enregistrés sont exportés en clair. La conservation et la manipulation des mots de passe doivent donc être traitées avec une extrême prudence.

Pour obtenir des informations détaillées sur la configuration interne du système, comme les options de configuration du cache et des modules frontend, nous vous recommandons de consulter le document otobo-system-configuration.txt. Cette source offre une vue d'ensemble complète de toutes les options de configuration.

Documentation des connexions

Les services Web offrent, dans un environnement de plus en plus numérisé, la possibilité de relier OTOBO à d'autres systèmes et services. Assurer une communication efficace et sécurisée signifie donc configurer les paramètres des services Web de manière précise. La suite de la documentation explique en détail les bases des paramètres pour les services Web dans OTOBO afin de vous offrir un guide d'action plus complet.

Paramètres d'interface généraux

• Nom*

  • Le nom identifie de manière unique le service Web dans OTOBO. Il est important de choisir un nom clair et descriptif qui reflète la fonction ou le partenaire avec lequel il interagit.

• Description

  • Un commentaire étendu qui décrit en détail l'objectif et la fonctionnalité du service Web. Cela facilite la compréhension et la maintenance.

• Système distant

  • Permet de définir le nom du système externe avec lequel OTOBO interagit.

• Seuil de débogage

  • Choisissez la manière dont la journalisation de la communication doit être effectuée. Les paramètres vont de Débogage (journalisation la plus détaillée) à Erreur (seulement les messages d'erreur).

• Validité

  • Détermine si le service Web est activé (valide) ou désactivé (non valide, temporairement non valide). Seuls les services Web valides sont exécutés par OTOBO.

Transport réseau - SOAP ou REST

Pour la mise en œuvre de l'intégration avec d'autres systèmes, différents protocoles sont proposés. Le choix du transport réseau est fondamental :

• Transport réseau

  • Choisissez entre HTTP::REST et HTTP::SOAP. Ces protocoles définissent comment les données sont transmises 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 variété d'opérations pré définies, comme par exemple Ticket::TicketCreate pour créer des 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 réalise de nouvelles dimensions d'automatisation et d'intégration, ce qui peut considérablement améliorer l'efficacité des processus et la satisfaction client.

Services Web OTOBO pour la classification des tickets (ATC)

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

Avertissement de sécurité

N'oubliez pas que lors de l'exportation des paramètres des services Web, les mots de passe peuvent être exportés en clair. Il est donc essentiel de traiter les informations sensibles de manière protégée et de respecter les mesures de sécurité.

L'utilisation efficace des services Web dans OTOBO permet aux entreprises de concevoir leurs flux de travail de manière plus intelligente et plus agile. Grâce à la configuration précise des paramètres des services Web, une base solide est créée pour intégrer OTOBO de manière transparente dans l'écosystème numérique de l'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 une partie essentielle pour assurer une gestion de tickets efficace. Cette intégration est rendue possible par la définition de diverses opérations qui peuvent exécuter des actions spécifiques dans le cycle de vie d'un ticket. Une partie importante de cette intégration est la compréhension des attributs nécessaires pour chaque opération, ainsi que l'utilisation de la norme XLST pour la transmission des données.

Attributs requis pour les opérations d'interface

Pour les opérations de ticket de base dans OTOBO, des attributs spécifiques sont nécessaires. Voici des liens vers les ressources officielles qui décrivent en détail les attributs nécessaires pour la création, la récupération, la mise à jour, la recherche et la récupération 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 de manière précise et de s'assurer que toutes les demandes contiennent les informations nécessaires pour être traitées avec succès.

Utilisation de la norme XLST pour la transmission des données

La transformation XLST est une technique puissante pour convertir les données entrantes des requêtes de service Web en un format que OTOBO peut traiter. 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 vous pouvez transformer la valeur de l'attribut incidentID entrant en un champ de ticket dynamique nommé RemoteTicketID.

Paramètres des services Web : demandeur (Requester)

Pour la mise en œuvre des procédures de service Web en tant que demandeur, OTOBO propose le choix entre les protocoles HTTP::REST et HTTP::SOAP. Le choix du transport réseau est élémentaire pour assurer une connexion correcte avec le système externe. Après avoir choisi le transport, la configuration doit être enregistrée et adaptée aux besoins 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 de services Web hautement configurable, OTOBO ouvre un monde de possibilités pour l'intégration et l'automatisation des processus de gestion de tickets. En fournissant des spécifications précises et en utilisant des normes comme XLST pour la manipulation des données, OTOBO offre à ses utilisateurs une base flexible pour étendre leurs systèmes de tickets en fonction de leurs besoins métier spécifiques.

Que ce soit en tant que fournisseur ou demandeur, le traitement précis des paramètres des services Web garantit une communication transparente et efficace avec les systèmes et services externes.