OTOBO / Znuny Services Web - API REST

Introduction à l'intégration des interfaces externes

INFO

Cet article sur les services Web présente une grande superposition avec l'article API REST API REST.

Dans un monde interconnecté mondialement, les systèmes de tickets doivent être capables de réagir automatiquement aux requêtes d'autres systèmes et d'envoyer des requêtes ou des données à des services externes. OTOBO, le puissant système de tickets open-source, relève ce défi grâce à 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 :

• Systèmes CRM
• Systèmes de gestion de projet
• Systèmes de gestion de documents
• Et de nombreuses 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 transférées et interprétées. Avec OTOBO, vous pouvez configurer des services Web pour exécuter des actions en interne, initier des requêtes 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 & Automatisation. Une nouvelle installation de OTOBO ne contient par défaut aucun service Web préconfiguré. 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, il convient de se 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 de services Web dans OTOBO permet une intégration flexible et dynamique de vos processus métier avec de nombreux outils et systèmes externes. En générant et en utilisant ces Services, l'efficacité est accrue en réduisant les interventions manuelles et en diminuant les temps de réponse aux requêtes des clients. De plus, la polyvalence de l'interface générique garantit que OTOBO est extensible de manière quasi illimitée, s'intégrant 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 un soin particulier.

Pour des informations détaillées sur la configuration interne du système, telles que les possibilités de configuration du cache et des modules frontaux, nous vous 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 connecter OTOBO à d'autres systèmes et services. Assurer une Communication efficace et sécurisée signifie donc configurer précisément les paramètres des services Web au préalable. Les bases des paramètres des services Web dans OTOBO sont expliquées plus en détail ci-dessous afin de vous fournir un guide d'action plus complet.

Paramètres Généraux des Interfaces

• Nom*

  • Le nom identifie de manière unique le service Web 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 le but 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 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 variété d'opérations prédéfinies, telles que 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 considérablement augmenter l'efficacité des processus et la satisfaction des clients.

Services Web OTOBO Classification de Tickets IA (ATC)

Pour utiliser la Classification de Tickets IA (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 des tickets et effectuer la classification. Classification de Tickets OTOBO

Avis 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 avec protection et de respecter les réglementations 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. En configurant précisément les 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 diverses opérations qui peuvent exécuter des actions spécifiques dans le cadre du cycle de vie des tickets. 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 le transfert de données.

Attributs Requis pour les Opérations d'Interface

Pour les opérations de tickets 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 requis pour la création, la récupération, la mise à jour, la recherche et 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 requêtes contiennent les informations nécessaires pour être traitées avec succès.

Utilisation de la Norme XLST pour le Transfert de Données

La transformation XLST est une technique puissante pour transférer les données entrantes des requêtes de services Web dans un format 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 de procédures de services Web en tant que demandeur, OTOBO offre le choix entre les protocoles HTTP::REST et HTTP::SOAP. Le choix du transport réseau est essentiel 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 de services Web hautement configurable, 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 normes telles que XLST pour la manipulation des données, OTOBO offre à ses utilisateurs une base flexible pour étendre leurs systèmes de ticketing conformément à 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 assure une Communication transparente et efficace avec les systèmes et services externes.