Piloter Qual’IT via l’API REST

Le pilotage d’application au travers de WebServices est de plus en plus répandu dans le monde de l’entreprise. La métrologie réseau et applicative n’échappe pas à la règle. Ces API servent dans de nombreux cas de figure pour offrir à un opérateur d’exploitation un portail de services unique, fournir des statistiques sur une interface client, intégrer un outil dans un portail de supervision unifié ou réaliser des statistiques avancées à l’aide d’un outil de BI tiers.

Les WebServices dans Qual’IT

Nous avons donc intégré en standard à la version 5.2 de Qual’IT une API WebServices en REST afin de permettre à un système tiers de dialoguer avec Qual’IT et de lui fournir une possibilité de configurer certains paramètres, lancer des tests et récupérer des résultats de test.

Souhaitant garder la philosophie multi utilisateur de Qual’IT, qui permet de contrôler les actions des utilisateurs sur l’application, nous avons intégré une méthode simple d’authentification permettant de fournir une clé propre à chaque utilisateur de Qual’IT dans l’entête des requêtes REST afin de vérifier ses droits.

Le format des réponses par défaut est le JSON. Cependant, celui-ci peut être changé en ajoutant à la fin de l’url l’extension XML.COMMENT UTILISER L’API REST DANS QUAL’IT ?

• Générer une clé d’accès, celle ci est récupérable sur votre compte Qual’IT.

• Copiez ensuite la clé dans votre client REST en ajoutant l’entête X-API-KEY:

MAINTENANT C’EST À VOUS DE JOUER !

Dans note API REST 4 opérations distinctes sont possibles, les voici décrites ci-dessous :

• POST : Création d’une ressource (exemple : une box, une zone etc…)
• PATCH : Mise à jour d’une ressource
• DELETE : Suppression d’une ressource
• GET : récupération d’une ou plusieurs ressources

Toutes ces opérations ne sont pas à mettre entre toutes les mains. C’est pourquoi le système de droit permet de gérer à la fonctionnalité près ce à quoi chaque utilisateur peut accéder.

Pour chaque demande, le serveur vous renverra un message ainsi qu’un code retour.

Ces codes retour (code HTTP) peuvent être :

• 200 si la requête a pu être traitée avec succès,
• des variantes sont 201 ou 204, suivant l’opération qui a été demandée au serveur,
• 304 si le document demandé n’a pas été modifié depuis la dernière fois que le client l’a demandé,
• 400, 401, 402, 403, 404, 406, 409, 429 sont des codes d’erreur adaptés à différentes situations d’erreur d’utilisation de l’API,
• 500 ou 503, suivant que votre application subit un problème technique, est indisponible temporairement.

EXEMPLE DE REQUÊTE :

Vous souhaitez récupérer l’ensemble des zones disponibles sur votre plateforme :

https://URL-DE-MON-SERVEUR/api/zones.json

Ou bien pour une réponse en XML :

https://URL-DE-MON-SERVEUR/api/zones.xml

Pour connaitre les possibilités offertes par cette API REST, vous pouvez vous reporter à la rubrique Aide de Qual’IT et télécharger la documentation vous expliquant toutes les requêtes disponibles.

"Vision One d’Ixia fournit une riche combinaison de caractéristiques et de fonctionnalités qui répondent aux besoins de visibilité et de sécurité spécifiques de nos clients de l'entreprise. En particulier, la nouvelle plate-forme Vision One est unique dans sa capacité à fournir un point d'entrée à bas coût, permettant à nos clients de se développer ensuite selon le besoin."

Jean-Marc ODET
DG IJNEXT Groupe INTERDATA & TENEDIS