[Guide] Les bases des URL de rappel Postman

Dans le domaine du développement et des tests d'API, Postman est un outil puissant. Sa capacité à rationaliser les flux de travail et à simplifier les interactions avec les API est indéniable. Cependant, certaines fonctionnalités, comme l'autorisation OAuth 2.0, reposent sur un mécanisme essentiel connu sous le nom d'URL de rappel.

Cet article explore le concept des URL de rappel Postman, expliquant leur rôle dans les processus d'authentification et comment elles contribuent à une expérience de développement d'API transparente.

Que sont les URL de rappel ?

Dans le domaine des applications web et des API, la communication ne se fait pas toujours dans une seule direction. Souvent, une application ou un service doit renvoyer des informations après avoir terminé une tâche ou une action initiée par un autre système.

C'est là que les URL de rappel entrent en jeu. Elles agissent comme des adresses de retour désignées, spécifiant un emplacement web spécifique où la réponse ou la mise à jour peut être envoyée.

Comment fonctionnent les URL de rappel ?

Étape 1 - Lancement de l'action

Imaginez que vous utilisez une application web pour télécharger un fichier vidéo volumineux à des fins de traitement. L'application envoie une requête à un serveur contenant les données vidéo et les instructions.

Étape 2 - Long temps de traitement

Le traitement de la vidéo peut prendre beaucoup de temps. Le serveur ne peut pas simplement maintenir la connexion ouverte en attendant que votre application vérifie l'achèvement.

Étape 3 - Spécification de l'URL de rappel

C'est ici que l'URL de rappel entre en jeu. Vous, en tant qu'utilisateur, fournissez au serveur une adresse web spécifique (l'URL de rappel) au sein de votre application. Cela indique au serveur où envoyer une notification une fois le traitement terminé.

Étape 4 - Envoi de la réponse

Lorsque le traitement est terminé, le serveur envoie une réponse contenant des informations sur les résultats (par exemple, succès ou échec, détails du traitement) à l'URL de rappel prédéfinie dans votre application.

Étape 5 - Réception de la notification

Votre application n'a pas besoin de vérifier constamment les mises à jour. Elle reçoit la notification automatiquement à l'URL de rappel désignée, ce qui vous permet d'être informé de l'achèvement et de tous les détails pertinents.

Postman et les URL de rappel

Postman utilise les URL de rappel pour rationaliser le processus d'autorisation OAuth 2.0, une norme largement utilisée pour accorder l'accès aux API.

Qu'est-ce qu'OAuth 2.0 ?

OAuth 2.0 est un framework d'autorisation qui permet aux utilisateurs d'accorder l'accès à leurs comptes sur une plateforme (par exemple, Google) à une autre application (par exemple, une application personnalisée) sans partager directement leurs mots de passe. Cela garantit un moyen sûr et contrôlé pour les applications d'accéder aux données des utilisateurs.

Le rôle des URL de rappel dans OAuth 2.0

Le flux d'autorisation OAuth 2.0 implique généralement plusieurs étapes :

1. Autorisation de l'utilisateur : L'application redirige l'utilisateur vers le serveur d'autorisation (par exemple, la page de connexion Google).
2. Octroi de l'autorisation : L'utilisateur se connecte et accorde à l'application l'autorisation d'accéder à des données spécifiques.
3. Code d'autorisation : Le serveur d'autorisation renvoie un code d'autorisation à l'URL de rappel préconfigurée de l'application.

Processus d'URL de rappel de Postman

Spécification de l'URL de rappel

Dans Postman, vous configurez l'URL de rappel souhaitée pour votre application. Cette URL peut être une adresse locale spécifique à Postman (fournie par Postman lui-même) ou une URL accessible au public pour votre application réelle.

Interception du code

Lorsque le serveur d'autorisation redirige l'utilisateur vers l'arrière avec le code d'autorisation, Postman, au lieu de votre application réelle, reçoit le code à l'URL de rappel définie (locale ou publique selon votre configuration).

Requête de jeton (aucune redirection nécessaire)

Étant donné que Postman intercepte le code, il n'a pas besoin de rediriger l'utilisateur vers une application distincte. Il utilise directement ce code pour faire une requête au serveur d'autorisation pour le jeton d'accès final, qui est utilisé pour interagir avec l'API.

Avantages de l'utilisation des URL de rappel dans Postman

• Commodité : Postman gère l'ensemble du flux d'autorisation en interne, éliminant le besoin de redirections complexes et d'interaction utilisateur en dehors de Postman.
• Efficacité : Le processus devient plus rapide et plus rationalisé, ce qui vous permet d'obtenir rapidement des jetons d'accès pour tester les appels d'API.
• Flexibilité des tests : Vous pouvez facilement tester différents scénarios d'autorisation en modifiant l'URL de rappel ou en utilisant différents fournisseurs OAuth dans Postman.

Comment configurer l'URL de rappel dans Postman pour l'autorisation OAuth 2.0 ?

Étape 1 - Accéder aux paramètres d'autorisation

Une fois que vous avez ouvert Postman, accédez à votre collection ou requête souhaitée et cliquez sur l'onglet Authorization.

Étape 2 - Sélectionnez le type d'authentification sur OAuth 2.0

Ensuite, appuyez sur la case Auth Type et sélectionnez OAuth 2.0. Cela modifiera la colonne de droite, vous fournissant beaucoup plus de champs à modifier.

Étape 3 - Spécifiez l'URL de rappel

Faites défiler vers le bas jusqu'à ce que vous trouviez la section URL de rappel, comme indiqué dans l'image ci-dessus. Ici, assurez-vous d'inclure votre URL de rappel. Vous avez deux options pour l'URL de rappel :

Choix 1 - Utilisation de l'URL locale de Postman (pour les tests)

Si vous effectuez uniquement des tests dans Postman, une option pratique consiste à utiliser l'URL locale fournie par Postman. Cette URL commence généralement par https://app.getpostman.com/oauth2/callback.

Cette approche maintient tout dans Postman, simplifiant le processus de test.

Choix 2 - Utilisation de l'URL publique de votre application (pour les tests de type production)

Si vous souhaitez simuler un scénario plus réaliste, vous pouvez configurer l'URL de rappel publique réelle de votre application. Cependant, cette URL doit être enregistrée auprès du serveur d'autorisation que vous utilisez (par exemple, Google, Facebook).

Étape 4 - Enregistrez les modifications apportées à votre API

Enfin, une fois toutes les modifications apportées, assurez-vous de les enregistrer.

Apidog - Rationalisez le développement d'API dans un environnement propre et élégant

Développeurs, recherchez-vous un changement de décor pour le développement de vos API ? Eh bien, ne cherchez pas plus loin - vous présentant Apidog, une alternative puissante à Postman qui vous équipe d'outils complets pour l'ensemble du cycle de vie de l'API.

Sélection de l'authentification OAuth 2.0 pour votre API à l'aide d'Apidog

Sur Apidog, vous pouvez facilement faire de même, sauf avec une interface utilisateur plus simple mais élégante.

Naviguez vers une API ou une requête que vous souhaitez modifier et sélectionnez l'en-tête Auth. Le type d'authentification par défaut sélectionné serait Hériter du parent, alors sélectionnez OAuth 2.0.

Spécification de l'URL de rappel dans Apidog

Une fois le type d'authentification OAuth 2.0 sélectionné, vous pouvez faire défiler vers le bas et spécifier d'autres détails. Parmi ces détails se trouve l'URL de rappel. Vous êtes libre de spécifier l'URL de votre choix ici, comme indiqué dans l'image ci-dessus.

Importer des API vers Apidog pour modification

Faites votre premier pas pour perfectionner votre API en les important sur Apidog. Apidog prend en charge divers types de fichiers API, notamment OpenAPI (ou Swagger), Postman et Insomnia.

Tout d'abord, ouvrez la section Paramètres de votre projet et recherchez le bouton Importer des données sous Gestion des données. Si vous ne trouvez pas le type de fichier que vous souhaitez importer, ne vous inquiétez pas ! Faites simplement glisser et déposez le fichier dans la partie inférieure de l'écran.

Ajout de scripts de test dans Apidog

Une fois que vous avez terminé d'importer votre API ou de créer un nouveau projet sur Apidog, vous pouvez procéder à l'ajout de scripts de test.

Sous la section Modifier de votre API, recherchez le titre Pré-processeurs. Vous devriez trouver une barre intitulée Script personnalisé. C'est ici que vous pouvez implémenter des scripts personnalisés pour vos requêtes d'API. Si vous avez du mal à comprendre quoi écrire, vous pouvez également sélectionner les options Extraits de code situées à droite de l'espace de code.

Conclusion

Les URL de rappel Postman jouent un rôle essentiel dans la rationalisation des flux de travail d'autorisation OAuth 2.0 dans le processus de développement et de test. En spécifiant une URL de rappel, vous éliminez le besoin de redirections complexes et d'interactions d'applications externes. Postman intercepte de manière transparente le code d'autorisation et récupère le jeton d'accès, ce qui vous permet de vous concentrer sur le test des appels d'API avec une plus grande efficacité.

Cette fonctionnalité, ainsi que l'interface conviviale globale de Postman, en font un outil puissant pour les développeurs travaillant avec des API qui utilisent OAuth 2.0 pour le contrôle d'accès sécurisé.