Comment utiliser l'API ProAbono avec Insomnia

Insomnia est un client REST qui envoie des requêtes HTTP et affiche les réponses des APIs REST. Les requêtes y sont enregistrées, organisées en espaces de travail et partagées, et des environnements personnalisés portent les variables dont une requête a besoin — ce qui le rend utilisable face à une API demandant une authentification. Il est gratuit et disponible sous Windows, Mac et Linux.

Procédure

1. Installer Insomnia

Télécharger le client correspondant au système d’exploitation utilisé depuis la page de téléchargement d’Insomnia.

2. Exporter la collection ProAbono depuis Postman

La collection ProAbono — l’ensemble des requêtes prédéfinies couvrant l’API — n’est publiée que pour Postman ; elle rejoint Insomnia par un export :

1. Importer la collection dans Postman, avec le bouton présenté sur Comment utiliser l’API ProAbono avec Postman.
2. Dans Postman, ouvrir le menu de la collection et choisir Export.
3. Conserver le format Collection v2.1 et enregistrer le fichier JSON.

3. Importer la collection dans Insomnia

Dans Insomnia, choisir Import dans le menu de l’espace de travail, puis From File, et sélectionner le fichier JSON exporté ci-dessus. Le format Postman v2.1 est lu nativement et chaque ressource ProAbono devient un dossier de requêtes.

4. Configurer un environnement

L’authentification est de type Basic Access : la clé Agent tient lieu de nom d’utilisateur et la clé API de mot de passe, toutes deux relevées dans le BackOffice (Comment récupérer mes clés API). Ouvrir Manage Environments et créer un environnement portant l’URL de base et les deux identifiants — sous forme de noms de variables d’environnement, jamais des clés elles-mêmes :

{
  "base_url": "https://api-42.proabono.com/v1/",
  "agent_id": "$PROABONO_AGENT_ID",
  "agent_key": "$PROABONO_AGENT_KEY"
}

5. Envoyer une première requête

Ouvrir l’une des requêtes importées — la lecture d’un client est la plus courte — renseigner cust-42 dans ReferenceCustomer et l’envoyer. Une réponse 200 portant le client confirme l’environnement ; une réponse 401 signale que les deux clés sont inversées. Toutes les ressources couvertes par la collection sont décrites dans la documentation de l’API.

Peut-on importer des collections à Insomnia ?

Oui, et pas seulement depuis un fichier. Une collection s’importe également depuis une URL — Import > From URL — ou depuis la ligne de commande avec la commande “insomnia import”. Les formats JSON et YAML sont tous deux acceptés, que la collection ait été exportée depuis Insomnia ou depuis un autre client REST. Consultez la documentation d’Insomnia pour obtenir plus d’informations sur l’utilisation de la ligne de commande.

Quelles sont les différences entre Postman et Insomnia ?

Postman et Insomnia sont tous deux des outils populaires pour tester et déboguer les APIs REST. Voici quelques différences clés entre les deux :

1. Plateformes supportées : Postman est disponible sous Windows, Mac, Linux et en tant qu’extension de navigateur, tandis qu’Insomnia est disponible sous Windows, Mac et Linux.
2. Prise en charge des protocoles : Postman prend en charge un large éventail de protocoles, notamment HTTP, HTTPS, REST, GraphQL et SOAP, tandis qu’Insomnia se concentre principalement sur les requêtes HTTP et REST.
3. Gestion des environnements : Postman propose une fonctionnalité de gestion des environnements avancée qui permet de définir des variables d’environnement et de les utiliser dans les requêtes, tandis qu’Insomnia offre également une gestion des environnements, mais elle est moins avancée.
4. Collaboration : Postman propose une fonctionnalité de collaboration en temps réel qui permet aux utilisateurs de travailler sur les mêmes collections en même temps, tandis qu’Insomnia ne propose pas cette fonctionnalité.
5. Prix : Postman est gratuit pour une utilisation personnelle, mais propose des plans payants pour les entreprises. Insomnia est gratuit à tous les niveaux.

Il est important de noter que ces différences ne sont que quelques-unes des nombreuses différences entre Postman et Insomnia. Il est recommandé de les essayer tous les deux et de choisir celui qui convient le mieux à vos besoins.