Motimate : Comment importer la documentation de l'API publique de Motimate dans Postman ?

Introduction

Si vous êtes un développeur d'API, vous savez combien il est important de tester et de documenter votre application pour garantir sa fonctionnalité et sa fiabilité. Postman est un outil populaire parmi les développeurs car il fournit une interface conviviale pour effectuer des requêtes HTTP, tester les points d'extrémité et visualiser les réponses.

L'une des principales caractéristiques de cet outil est la possibilité d'importer de la documentation au format Open API. Dans cet article, nous vous guiderons dans le processus d'importation de la documentation de l'API publique de Motimate (au format Open API 3.0) dans une collection Postman, ce qui rendra vos tests et votre développement de l'API plus efficaces.

Exigences

Avant de commencer, Postman doit être installé sur votre système. Vous pouvez télécharger Postman ici.

Importer l'API Motimate pour les collections Postman :

1. Allez sur la page de téléchargement de la documentation de l'API publique de Motimate(ici).
    
2. Recherchez le bouton Exporter dans le coin supérieur droit et cliquez dessus. Sélectionnez Download API, puis JSON Unresolved.
    
3. Une fois le fichier téléchargé, ouvrez Postman.
   
   
    
4. Ouvrez l'onglet Collections et cliquez sur Importer. Télécharger le fichier téléchargé en tant que collection.
   
   
    
5. Il est temps de configurer notre autorisation - cliquez sur Motimate Public API et sélectionnez l'onglet Variables.
   
   
    

6. Ajoutez une nouvelle variable nommée clientId et définissez la valeur initiale à la valeur fournie par Motimate. La valeur actuelle sera automatiquement mise à jour.
   
   puis...
   
    

   Ajoutez une nouvelle variable nommée clientSecret et définissez la valeur initiale à la valeur fournie par Motimate. La valeur actuelle sera automatiquement mise à jour.
   
   
   
    

7. Très important : cliquez sur Enregistrer !
   
   
   
    
8. Cliquez à nouveau sur Motimate Public API et sélectionnez l'onglet Autorisation.
   
   
    

9. Définir le type sur OAuth 2.0. Un formulaire doit apparaître. Faites défiler la page jusqu'à la section Configure New Token (Configurer un nouveau jeton ).

   Si vous voyez l'info "Some changes to the Token…", cliquez simplement sur Edit Token Configuration.
   
   
   
    

10. Définissez le type d'octroi sur Créances du client:
    1. Définir l'URL du jeton d'accès à {{baseUrl}}/oauth/token
    2. Définir l'identifiant du client sur {{clientId}}
    3. Définir le secret du client sur {{clientSecret}}
       
       
       
        
11. Faites défiler vers le bas et cliquez sur Obtenir un nouveau jeton d'accès. Le facteur devrait vous informer de la réussite de l'authentification. Cliquez sur Continuer, puis sur Utiliser le jeton.
    
     
12. Très important : cliquez sur Enregistrer !
    
     

13. Cliquez sur : me → fetch Current Organization → Send.

    Vous devriez voir une réponse de l'API publique de Motimate, avec les données de votre organisation.
    
    
    
     

    Félicitations ! Vous avez maintenant importé l'API publique de Motimate dans Postman Collections 🎉