Tester les APIs

Temps estimé :6 minutes

Pour bien commencer il vous faut un environnement de test.

Postman est un logiciel qui offre un environnement convivial pour tester, développer et documenter des API (interfaces de programmation d’applications). Il permet aux développeurs de créer, organiser et exécuter des requêtes HTTP de manière simple et efficace. Voici quelques fonctionnalités clés de Postman :

Création de requêtes HTTP : Les utilisateurs peuvent facilement créer des requêtes HTTP GET, POST, PUT, DELETE, etc., en spécifiant les paramètres, les en-têtes et les corps de requête.
Tests automatisés : Postman permet de définir des scripts de test pour vérifier automatiquement les réponses des API, garantissant ainsi leur bon fonctionnement.
Environnements : Il permet de gérer différents environnements (comme les environnements de développement, de test et de production) et de basculer entre eux sans effort.
Collections : Les requêtes peuvent être organisées en collections, ce qui facilite leur gestion, leur partage et leur documentation.
Documentation : Postman génère automatiquement une documentation interactive à partir des collections de requêtes, ce qui facilite la compréhension et l’utilisation des API.

En résumé, Postman est un outil essentiel pour les développeurs d’API, offrant des fonctionnalités puissantes pour tester, déboguer et collaborer sur le développement d’API de manière efficace.

1 – Téléchargement et Installation :

Rendez-vous sur le site officiel de Postman à l’adresse suivante : https://www.postman.com/downloads/ pour télécharger la version appropriée selon votre système d’exploitation.

Une fois le téléchargement terminé, suivez les instructions d’installation pour configurer Postman sur votre machine.

2 – Importation des API depuis un fichier JSON :

Pour importer les API depuis un fichier JSON, récupérez le fichier JSON contenant les spécifications d’API à partir du dépôt Github fourni : PBXware-API-Documentation.

Dans l’interface Postman, cliquez sur le bouton “Import” dans la barre de navigation supérieure.

Sélectionnez “Import File” et faites glisser le fichier JSON que vous avez récupéré depuis le dépôt GitHub. Postman créera automatiquement une nouvelle collection “PBXwareAPI_Doc” avec les endpoints et les paramètres spécifiés dans le fichier JSON.

3 – Renseignement des variables dans votre Workspace Postman :

Lorsque vous travaillez avec des API, il est courant d’utiliser des variables pour rendre les requêtes plus dynamiques et réutilisables.

Dans Postman, vous pouvez définir des variables d’environnement ou des variables de collection pour stocker des valeurs telles que les URL, les clés API, etc.

Pour définir une variable, accédez à l’onglet “Manage Environments” dans Postman et créez un nouvel environnement ou modifiez un existant. Entrez ensuite les valeurs nécessaires pour les variables utilisées dans vos requêtes API.

Exemple de requête :

voici le type de requête que vous allez trouver dans les API que vous avez importer

				
					GET http://{{IP}}/index.php?apikey={{CLEAPI}}&action=pbxware.dashboard.ext_online&server={{SRV/TENANT-ID}}

Les valeurs représentées comme ceci : {{IP}} font référence aux variables montrées dans l’image ci-dessus [3].

Dans le tableau il vous faudra les rajouter afin de pouvoir lancer la requête avec succès :

				
					• {{IP}} = URL/IP de votre PBXware
• {{CLEAPI}} = Clé API secrète disponible sur votre PBXware
• {{SRV/TENANT-ID}} = ID du serveur tenant dans l’ordre de création : 2, 3, 4 etc…

NOTE :

L’ID numéro 1 est réservé au Master-Tenant

Remplissez toutes les valeurs dont vous aurez besoin pour faire vos tests.

l’idéal c’est de lancer un .list depuis l’action principale pour avoir les valeurs inconnues etc…

Trouver votre clé API sur PBXware :

https://wiki.bicomsystems.fr/documentation/pbxware-mt/reglages-de-ladmin/#clés-api

4 – Utilisation des requêtes :

Une fois les variables définies, vous pouvez accéder aux différentes requêtes présentes dans la collection importée.

Chaque requête est configurée avec des paramètres prédéfinis, mais vous pouvez les personnaliser en fonction de vos besoins en modifiant les valeurs des paramètres dans Postman.

Pour envoyer une requête, cliquez sur le bouton “Send” après avoir sélectionné la requête souhaitée. Postman enverra la requête à l’URL spécifiée avec les paramètres configurés et affichera la réponse dans la fenêtre de sortie.

Voir image ci-dessous.

En suivant ces étapes, vous pourrez rapidement importer, configurer et utiliser les API de PBXware à l’aide de Postman, facilitant ainsi le processus de test et de développement des API.

Objets

Tester les APIs

NOTE :

Tester les APIs

CONTENU