Collection Postman pour la fonctionnalité de gestion des API

4 min read
Résumez cela avec l'IA

À mesure que l'utilisation de la fonctionnalité de gestion des API de SnapLogic se généralise, de plus en plus d'entreprises et d'organisations trouvent que le portail API est un outil utile non seulement pour publier les API créées au sein de la plateforme, mais aussi pour publier et créer leur catalogue d'API externes ou proxy dans leur écosystème. En particulier dans les organisations qui ont développé des microservices pour soutenir leurs initiatives avant d'adopter une plateforme d'intégration, tous les créateurs d'API ne sont pas nécessairement des intégrateurs SnapLogic. Ces microservices externes ou services tiers et les API d'intégration développées avec les pipelines SnapLogic ont en commun un cycle de vie complet, généralement pris en charge par des procédures, des outils et des automatisations DevOps. 

Prenons l'exemple d'un microservice hérité qui pourrait contrôler le moteur pas à pas d'une caméra de sécurité. Il ne s'agit pas spécifiquement d'une application ou d'un service d'intégration de données, mais il expose une API pour envoyer un signal à un appareil. SnapLogic peut facilement gérer l'API de ce microservice en tant que proxy dans APIM, et les intégrateurs peuvent découvrir et se renseigner sur cette API dans le catalogue. Si le fabricant met à jour le micrologiciel de la caméra et fournit une API mise à jour à utiliser, grâce aux API publiques APIM de SnapLogic, l'équipe DevOps peut écrire un script pour mettre à jour le micrologiciel de chaque appareil et gérer en même temps la documentation et la définition de l'API dans SnapLogic APIM. Sans ces API, l'équipe de déploiement pourrait avoir à supporter les frais généraux liés à la coordination manuelle de la mise à jour de la définition de l'API.

Les API disponibles offrent également des fonctionnalités permettant de migrer à la fois les API SnapLogic et les API proxy. Si l'équipe d'intégration travaille avec une équipe DevOps pour déplacer des éléments de Dev vers Test vers Prod, ou peut-être d'une région à l'autre, les API publiques rendent cette opération rapide et facile.

Afin de faciliter l'apprentissage des API publiques et permettre aux équipes de les tester, nous avons créé une collection d'API publiques jointe à cet article. Chaque exemple est entièrement paramétré et accompagné d'un environnement Postman. En chargeant une API dans Postman et en configurant l'environnement correspondant, les intégrateurs ou ingénieurs peuvent rapidement créer des exemples qu'ils peuvent exploiter dans leur organisation.

Installation

Le fichier joint peut être décompressé sur un poste de travail personnel, et un utilisateur Postman peut créer un nouvel espace de travail. Dans cet espace de travail, il y aura un bouton d'importation où l'utilisateur pourra sélectionner la collection et tous les environnements d'un seul coup.

Image 1 : Emplacement du bouton Importer
Image 2 : Sélection des fichiers à importer

Une fois cette opération terminée, l'ensemble des API et les environnements seront disponibles dans la barre de navigation de gauche. 

Image 3 : Exemples d'API chargées dans les collections
Image 4 : Variables d'environnement chargées dans Postman

Préparation

Une fois les environnements chargés, un environnement global doit être créé et configuré pour l'ensemble de la collection.Ajoutez les éléments suivants à votre environnement globalPostman :

  • utilisateur (utilisateur administratif IIP)

  • mot de passe (utilisateur administratif IIP)

  • pod_path (domaine – généralement elastic.snaplogic.com pour l'Amérique du Nord)

  • environnement (ce qui était autrefois le nom de l'organisation dans l'URL pour IIP)

Une fois configuré, votre environnement global ressemblera à l'image ci-dessous.

Image 5 : Variables globales configurées.

Utilisation de la collection

Une fois l'environnement global configuré, il ne reste plus qu'à configurer les valeurs dans l'environnement pour l'API spécifique testée, puis à ouvrir l'API et à définir son environnement sur celui qui vient d'être configuré.

À titre d'exemple, un intégrateur peut déjà disposer d'un ensemble de pipelines SnapLogic dans un projet qui sont destinés à être disponibles en tant qu'API dans APIM pour une utilisation dans toute l'organisation. La première étape de ce processus consiste à remplir les variables pour leur projet dans l'environnement Postman approprié. Dans la collection jointe à cet article, chaque requête de la collection aura un environnement correspondant. Pour la requête Créer APIM à partir du projet SL, l'environnement correspondant s'appelle égalementCréer APIM à partir du projet SL

Image 6 : Les variables de l'environnement seront utilisées dans la requête portant le même nom.

Une fois les variables configurées dans l'environnement, avant de tester l'API donnée, assurez-vous que l'environnement configuré est appliqué à la requête. Pour ce faire, utilisez le sélecteur situé dans le coin supérieur droit de la requête.

Image 7 : Application de l'environnement à la demande.

Une fois l'environnement configuré et appliqué à la requête, le bouton « Envoyer » peut être utilisé pour exécuter la requête. Cette collection peut désormais être utilisée à la fois pour tester l'API publique, et les intégrateurs peuvent utiliser les configurations variables pour aider leurs équipes DevOps à développer au mieux leurs automatisations pour gérer leurs microservices hérités avec les API SnapLogic modernisées. 

SnapLogic est la société d'intégration agentique.
Catégorie : Technique
A l'intérieur de la plateforme : Perspectives techniques des experts SnapLogic

Découvrez SnapLogic en action grâce à une visite interactive !

Visite interactive Image de démonstration