Appels d’API Postman

Introduction

Cet article va plonger en profondeur dans les fondamentaux des services web, vous dotant des connaissances et d’exemples pratiques nécessaires pour devenir compétent dans la réalisation d’appels d’API avec Postman.

Les services web constituent une composante essentielle des applications modernes depuis plus de deux décennies, évoluant considérablement depuis les années 2000. Ces services dépendent fortement des API (Interfaces de Programmation d’Applications) pour communiquer et échanger des données. En tant que développeurs et testeurs, nous avons besoin d’outils robustes pour interagir efficacement avec ces API. C’est là que Postman – un outil populaire de test et de développement d’API entre en jeu.

L’interface web de DataSunrise repose sur des appels d’API utilisant des requêtes RPC et des requêtes POST en JSON. Même lorsqu’une commande est exécutée dans la Interface en Ligne de Commande (CLI), le JSON requis est créé en fonction des options de la commande, qui est ensuite transmis au backend pour appeler le RPC nécessaire. Ce processus est également utilisé dans la Console Web pour créer et gérer des règles ainsi que d’autres configurations.

Qu’est-ce que Postman ?

Postman est un outil populaire de développement et de test d’API qui simplifie le processus d’envoi de requêtes, l’analyse des réponses et la gestion des API. Il offre une interface conviviale pour créer et exécuter des appels d’API, facilitant ainsi le travail des développeurs avec les services web.

Comprendre les Services Web

Les services web sont des applications ou des composants qui communiquent via des réseaux en utilisant des protocoles web standards. Ces services permettent à différents systèmes logiciels d’interagir et d’échanger des données de manière transparente, quelle que soit la technologie ou la plateforme sous-jacente.

Caractéristiques Clés des Services Web

Indépendance de la Plateforme : Les services web peuvent être accessibles depuis tout appareil ou système d’exploitation disposant d’une connexion Internet.
Interopérabilité : Ils permettent à différents systèmes de communiquer en utilisant des protocoles et des formats de données standardisés.
Scalabilité : Les services web peuvent gérer plusieurs clients et évoluer en fonction de la demande.
Réutilisabilité : Une fois créés, les services web peuvent être utilisés par plusieurs applications, favorisant la réutilisation du code et l’efficacité.

Qu’est-ce que RPC ?

Le Remote Procedure Call (RPC) est un protocole (JSON-RPC) qui permet à un programme d’exécuter une procédure ou une fonction sur un autre ordinateur comme s’il s’agissait d’un appel de procédure local. Le RPC est l’une des premières formes de calcul distribué et a joué un rôle important dans le développement des services web.

Caractéristiques Principales du RPC :

Transparence de Localisation : Le programme appelant n’a pas besoin de connaître l’emplacement physique de la procédure appelée.
Communication Synchrone : Le RPC suit généralement un modèle de requête-réponse, où l’appelant attend la réponse avant de continuer.
Orienté Procédure : Le RPC se concentre sur l’appel de procédures ou de fonctions spécifiques sur des systèmes distants.

Comprendre les API

Une Interface de Programmation d’Applications (API) est un ensemble de règles, de protocoles et d’outils qui permettent à différentes applications logicielles de communiquer entre elles. Les API définissent les méthodes et les formats de données que les applications peuvent utiliser pour demander et échanger des informations.

Types d’API

SOAP (Simple Object Access Protocol) : Un protocole qui utilise XML pour l’échange de données structurées.
REST (Representational State Transfer) : Un style architectural qui utilise les méthodes HTTP standards pour la communication.
GraphQL : Un langage de requête pour les API qui permet aux clients de demander uniquement les données dont ils ont besoin.

Pourquoi les API sont Importantes

Intégration : Les API permettent une collaboration sans couture entre différents systèmes et applications.
Flexibilité : Elles permettent aux développeurs d’accéder à des fonctionnalités spécifiques d’autres applications sans avoir besoin de comprendre l’intégralité de leur code.
Efficacité : Les API peuvent réduire le temps de développement en fournissant des fonctionnalités préconstruites.
Scalabilité : Des API bien conçues peuvent gérer des charges accrues et une base d’utilisateurs en expansion.

Réaliser des Appels d’API avec Postman

Maintenant que nous comprenons les bases des services web et des API, explorons comment réaliser des appels d’API avec Postman. Nous passerons en revue deux exemples pour démontrer différents types d’appels d’API. JSONPlaceholder est un site web de test d’API. Il en existe d’autres en ligne.

Méthode GET : Une requête destinée à récupérer des données spécifiques à partir d’un serveur sans modifier aucune ressource, généralement utilisée pour obtenir des informations et sûre pour des appels répétés.

Méthode POST : Une requête destinée à soumettre des données pour être traitées et stockées par le serveur, souvent utilisée pour créer de nouvelles ressources ou soumettre des données de formulaire, ce qui peut modifier l’état du serveur.

Exemple 1 : Réaliser une Requête GET

Commençons par une requête GET simple pour récupérer des données depuis une API publique.

Ouvrez Postman et créez une nouvelle requête.
Définissez la méthode HTTP sur GET.
Entrez l’URL suivante : https://jsonplaceholder.typicode.com/posts/1
Cliquez sur le bouton “Send”.

Vous devriez recevoir une réponse similaire à celle-ci :

{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

Cet exemple démontre la facilité avec laquelle on peut récupérer des données d’une API en utilisant Postman. La réponse contient un objet JSON avec des informations concernant un post spécifique.

Exemple 2 : Réaliser une Requête POST

Créons maintenant une nouvelle ressource en utilisant une requête POST.

1. Créez une nouvelle requête dans Postman.

2. Définissez la méthode HTTP sur POST.

3. Entrez l’URL : https://jsonplaceholder.typicode.com/posts

4. Allez dans l’onglet “Body”, sélectionnez “raw” et choisissez “JSON” dans le menu déroulant.

5. Entrez le JSON suivant dans le corps de la requête :

jsonCopy{
  "title": "Mon Nouveau Post",
  "body": "Ceci est le contenu de mon nouveau post.",
  "userId": 1
}

Cliquez sur le bouton “Send”.

Vous devriez recevoir une réponse similaire à celle-ci :

jsonCopy{
  "title": "Mon Nouveau Post",
  "body": "Ceci est le contenu de mon nouveau post.",
  "userId": 1,
  "id": 101
}

Cet exemple illustre comment créer une nouvelle ressource en utilisant une requête POST. L’API répond avec l’objet créé, incluant un nouvel identifiant attribué par le serveur.

Si le serveur utilise HTTPS et possède un certificat auto-signé, il se peut que vous deviez désactiver la vérification du certificat SSL dans les paramètres de Postman.

Fonctionnalités Avancées de Postman pour les Appels d’API

Postman offre plusieurs fonctionnalités avancées qui peuvent améliorer votre flux de travail en matière de test et de développement d’API :

Variables d’Environnement

Postman vous permet de créer des variables d’environnement pour stocker et réutiliser des valeurs à travers plusieurs requêtes. Ceci est particulièrement utile pour gérer différents points de terminaison d’API ou des jetons d’authentification.

Pour utiliser les variables d’environnement :

Créez un nouvel environnement dans Postman.
Ajoutez des variables comme base_url ou api_key.
Utilisez ces variables dans vos requêtes en les entourant de doubles accolades, par exemple, {{base_url}}/api/endpoint.

Scripts Pré-Requête

Vous pouvez écrire du code JavaScript qui s’exécute avant l’envoi d’une requête. Ceci est utile pour générer des données dynamiques ou mettre en place une authentification.

Exemple de script pré-requête pour générer un timestamp :

pm.environment.set(“timestamp”, new Date().getTime());

Tests

Postman vous permet d’écrire des tests pour vos appels d’API en utilisant JavaScript. Ces tests peuvent valider les données de la réponse, vérifier les codes de statut ou effectuer d’autres assertions.

Exemple de script de test dans l’onglet Tests pour une nouvelle requête GET à https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}} :

// Analyser l'URL pour extraire le timestamp
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Afficher le timestamp dans la console
console.log("Timestamp utilisé :", timestamp);
// Ajouter le timestamp à la réponse pour plus de visibilité
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Définir la réponse modifiée pour la visualiser dans Postman
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Test pour s'assurer que le timestamp a été envoyé
pm.test("Requête envoyée avec timestamp", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Vérifiez l’onglet “Test Results” pour voir si le test a réussi. Consultez également l’onglet “Console” pour voir le timestamp affiché. Le corps de la réponse inclura désormais la valeur du timestamp.

Bonnes Pratiques pour Réaliser des Appels d’API avec Postman

Organisez Vos Requêtes : Utilisez des collections et des dossiers pour regrouper les requêtes connexes.
Utilisez le Contrôle de Version : Postman vous permet d’exporter des collections. Stockez-les dans des systèmes de contrôle de version comme Git.
Documentez Vos API : Utilisez la fonctionnalité de documentation de Postman pour créer une documentation d’API claire et interactive.
Automatisez les Tests : Utilisez le Collection Runner de Postman et l’outil en ligne de commande Newman pour automatiser vos tests d’API.
Gérez Correctement l’Authentification : Utilisez des variables d’environnement pour stocker des informations sensibles telles que les clés API ou les jetons.
Surveillez la Performance de l’API : Configurez des moniteurs dans Postman pour suivre la performance et le temps de disponibilité de l’API.

Conclusion

Maîtriser les appels d’API avec Postman est une compétence essentielle pour les développeurs et testeurs modernes. En comprenant les services web, les API et le RPC, vous pouvez tirer parti des fonctionnalités puissantes de Postman pour rationaliser vos processus de développement et de test d’API.

Nous avons couvert les bases de la réalisation d’appels d’API, exploré des fonctionnalités avancées de Postman et discuté des meilleures pratiques. Avec ces connaissances, vous êtes bien équipé pour aborder des interactions API complexes et construire des applications interconnectées robustes.

N’oubliez pas que la clé pour maîtriser les appels d’API avec Postman réside dans la pratique. Expérimentez avec différents types de requêtes, explorez des API publiques et mettez-vous au défi de créer des suites complètes de tests pour vos propres API.

Au fur et à mesure de votre progression dans le développement et le test d’API, pensez à explorer des sujets plus avancés tels que la sécurité des API, l’optimisation des performances et les tests d’intégration. Le monde des services web est vaste et en constante évolution, offrant d’innombrables opportunités d’apprentissage et de perfectionnement.