Comment puis-je commencer à utiliser l'API REST dans Postman ?
Réponse :
L'API REST de DocuWare est plus accessible que jamais. Veuillez consulter le guide suivant pour configurer Postman pour l'API REST.
Démarrage
Téléchargement de Postman
Plate-forme recommandée pour tester et créer des applications à l'aide de l'API REST.
Collection Postman de l'API REST de DocuWare
Collection préconfigurée d'appels d'API DocuWare pouvant être importés dans Postman, constamment mise à jour.
Importation de la collection Postman
- Décompressez le dossier de la Collection Postman téléchargé. Il doit contenir deux fichiers .json.
- L'un d'eux contient la collection d'appels API et l'autre est l'environnement qui contient certaines variables requises, telles que l'URL du Nuage DocuWare, le nom d'utilisateur et le mot de passe.
- Ouvrez Postman et utilisez l'option Importer en haut de l'éditeur de l'espace de travail.
- Glissez-déposez les deux fichiers ou accédez manuellement à l'emplacement de téléchargement pour les importer tous les deux.
- Acceptez l'invitation à importer les deux fichiers.
Définition des variables d'environnement
- Ouvrez l'onglet Environnements sur le côté gauche et sélectionnez notre environnement DocuWare nouvellement importé
- Vous remarquerez qu'il existe une multitude de variables différentes, mais la plupart d'entre elles sont spécifiques à un cas d'utilisation et peuvent être laissées de côté pour l'instant. Les variables les plus importantes pour commencer sont les suivantes :
- ServerUrl (se terminant par .cloud / .com, etc.) - nous remplissons le DocuWare/Platform dans une autre variable)
- Nom d'utilisateur
- Mot de passe
- Enregistrez vos modifications.
S'authentifier
Il y a plusieurs façons de s'authentifier en utilisant l'API REST, mais la plus simple est d'utiliser notre nom d'utilisateur et notre mot de passe. La collection Postman les a tous numérotés en conséquence pour simplifier le processus :- Ouvrez le dossier Authentication/OAuth dans la collection Postman.
- Commencez par l'appel 1. Get Responsible Identity Service et appuyez sur Send. Si la variable ServerUrl est correctement définie, vous devriez recevoir une réponse 200 :
- Procédez ensuite de la même manière pour l'appel 2. Obtenir la configuration du service d'identité
- Enfin, choisissez la méthode d'authentification que vous souhaitez utiliser. Dans cet exemple, nous utiliserons 3.a Request Token w/ Username & Password, et nous devrions recevoir notre jeton d'accès dans la réponse.
- Maintenant que vous êtes correctement authentifié, vous pouvez commencer à tester les divers autres appels de la collection Postman !
La plupart de notre documentation sur l'API REST peut être trouvée directement dans Postman lui-même via l'onglet Documentation sur le côté droit :
Le KBA est applicable aux organisations en nuage et sur site.
Veuillez noter : Cet article est une traduction de l'anglais. Les informations contenues dans cet article sont basées sur la ou les versions originales des produits en langue anglaise. Il peut y avoir des erreurs mineures, notamment dans la grammaire utilisée dans la version traduite de nos articles. Bien que nous ne puissions pas garantir l'exactitude complète de la traduction, dans la plupart des cas, vous la trouverez suffisamment informative. En cas de doute, veuillez revenir à la version anglaise de cet article.