Znuny Web Services - REST API

Introduction à l’intégration d’interfaces externes

::: info Cet article sur les Web Services présente un fort recoupement avec l’article REST API REST API. ::: Dans un environnement numérique mondialement connecté, les systèmes de tickets doivent pouvoir réagir de manière automatisée aux demandes d’autres systèmes tout en envoyant des données ou des requêtes à des services externes. Znuny, le puissant système de tickets open source, répond à cette exigence avec son Generic Interface. Il permet aux administrateurs, même sans connaissances approfondies en programmation, de configurer des services web pour des tâches variées. Znuny prend en charge la communication via les protocoles REST et SOAP et permet une intégration transparente avec :

Systèmes CRM
Outils de gestion de projet
Systèmes de gestion documentaire
et bien d’autres applications Un Web Service agit comme un pont entre Znuny 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 Znuny, vous pouvez configurer des Web Services 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 Web Services se trouve dans le module Web Services du groupe Processus & Automatisation. Une installation fraîche de Znuny ne contient par défaut aucun Web Service préconfiguré. La documentation suivante illustre comment les Web Services peuvent être créés, modifiés, supprimés, clonés, exportés et importés, ainsi que l’utilisation de l’outil de débogage.

Implémentation des interfaces

L’implémentation de Web Services dans Znuny permet une intégration flexible et dynamique de vos processus métier avec de nombreux outils et systèmes externes. La création et l’utilisation de ces services augmentent l’efficacité 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 Znuny est extensible de manière quasi illimitée et s’intègre ainsi parfaitement dans les paysages informatiques existants.

Sécurité et configuration

Lors de la configuration et de la sécurisation des Web Services, il convient 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 la documentation officielle de configuration système de Znuny.

Documentation des connexions

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

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

Nom*
- Le nom identifie le Web Service de manière unique au sein de Znuny. 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 Web Service. Cela facilite la clarté et la maintenabilité.
Système distant
- Permet de définir le nom du système externe avec lequel Znuny interagit.
Seuil de débogage
- Choisissez le niveau de détail de la journalisation de la communication. Les réglages vont de Debug (journalisation la plus détaillée) à Erreur (uniquement les messages d’erreur).
Validité
- Détermine si le Web Service est activé (valide) ou désactivé (invalide, temporairement invalide). Seuls les Web Services valides sont exécutés par Znuny.

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 Znuny et le système connecté.
Ajouter une opération
- Permet de définir des actions spécifiques, appelées opérations, pour le Web Service. 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 Web Services dans Znuny. 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 Znuny à 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 client.

Avis de sécurité

Veuillez noter que lors de l’exportation des paramètres des Web Services, 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 consignes de sécurité. L’utilisation efficace des Web Services dans Znuny permet aux entreprises de rendre leurs flux de travail plus intelligents et plus agiles. Grâce à la configuration précise des paramètres des Web Services, une base solide est créée, permettant d’intégrer Znuny de manière transparente dans l’écosystème numérique d’une entreprise.

Paramètres et opérations des Web Services dans Znuny

L’intégration de systèmes externes avec Znuny via des Web Services 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 capables d’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 de standards pour le transfert de données.

Attributs requis pour les opérations d’interface

Pour les opérations de base sur les tickets dans Znuny, des attributs spécifiques sont nécessaires. Les opérations les plus importantes comprennent :

TicketCreate : Crée un nouveau ticket avec l’article associé
TicketGet : Récupère des informations détaillées sur un ou plusieurs tickets
TicketUpdate : Met à jour les données de tickets existants
TicketSearch : Recherche des tickets selon des critères définis
TicketHistoryGet : Récupère l’historique d’un ticket Ces opérations permettent 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 XSLT pour le transfert de données

La transformation XSLT est une technique puissante pour transférer les données entrantes des requêtes de Web Service sous une forme traitable par Znuny. En créant par exemple un champ dynamique “RemoteTicketID” pour les tickets, vous pouvez stocker et traiter efficacement les données entrantes : Opérations Cet exemple montre comment transformer la valeur de l’attribut entrant incidentID en un champ dynamique de ticket nommé RemoteTicketID.

Paramètres des Web Services : Requester (Demandeur)

Pour l’implémentation de procédures de Web Service en tant que Requester, Znuny 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. Znuny permet d’implémenter et de configurer des modules spécifiques à cet effet.

Résumé et étapes suivantes

En fournissant une API polyvalente et configurable pour les Web Services, Znuny 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 standards comme XSLT pour la manipulation des données, Znuny offre à ses utilisateurs une base flexible pour l’extension de leurs systèmes de ticketing en accord avec leurs besoins métier spécifiques. Que ce soit en tant que Provider ou Requester, le traitement précis des paramètres des Web Services assure une communication transparente et efficace avec les systèmes et services externes.

Best Practices

Sécuriser l’authentification : Utilisez toujours HTTPS et des API-Keys pour les environnements de production
Implémenter la gestion des erreurs : Mettez en place des Error-Handlers dédiés pour les opérations critiques
Activer le logging : Utilisez le Debug-Logging pendant le développement et désactivez-le en production
Versionnement : Documentez les modifications apportées aux configurations des Web Services pour une meilleure traçabilité
Test : Testez minutieusement toutes les opérations dans un environnement de test avant de les mettre en production Avec une configuration minutieuse des Znuny Web Services, vous posez les bases d’une intégration réussie dans votre paysage informatique et bénéficiez de processus métier automatisés et efficaces.