Comment utiliser Postman

Postman est une plateforme API pour construire et utiliser des API. Lier votre projet Document360 à Postman est facile et peut être réalisé en quelques minutes. Vous pouvez utiliser le Postman sur site ou en ligne.

NOTE

Pour plus d’informations concernant la demande de Posteur, lisez les articles suivants.

• Comment télécharger l’application Postman ?

• Comment installer et mettre à jour l’application Postman ?

• Comment utiliser Postman ?

• FAQ dans Postman

Lier votre projet Document360 dans Postman

1. Les étapes ci-dessous sont basées sur la demande Postman sur site.

2. Ouvre la demande du facteur.

3. Dans la section Mon espace de travail , cliquez sur le bouton Importer .

   Un panneau pop-up d’Importation apparaît.

4. Saisissez l’URL ci-dessous dans le champ.
   https://apihub.document360.io/swagger/v2/swagger.json
   La fenêtre pop-up Choisir comment importer votre API apparaîtra avec deux options.

5. Sélectionnez l’option souhaitée

   • Collection du facteur (par défaut)

   • OpenAPI 3.0 avec une collection Postman

6. Cliquez sur le bouton Importer .

   Une fois l’importation terminée, l’action créera une requête d’exemple pour chaque terminaison, vous permettant de faire la requête rapidement.
   

   

Authentification dans Postman - Génération d’un jeton API

1. Dans la vue arborescente, développez l’API client de Document360.

2. Dans l’onglet Autorisation, définissez le type d’authentification sur clé API depuis le menu déroulant.

3. Entrez la variable désirée dans le champ Clé .

4. Entrez le jeton API dans le champ Value. Pour générer un jeton API, lisez l’article sur la génération de jeton.

   NOTE

   Génération d’un jeton API

   1. Naviguez dans () dans la barre de navigation de gauche du portail de la base de connaissances.

   2. Dans le panneau de navigation de gauche, allez au Knowledge base portal > Jetons API.

   3. Créez le jeton API désiré et copiez le jeton.

   (ou) Copiez le jeton à partir d’un jeton existant.

1. Dans la barre de navigation de gauche, allez dans Environnements.

2. Depuis le panneau de navigation de gauche, cliquez sur Créer des environnements.

3. Dans la colonne Variables , tapez un nom de variable, par exemple « base_URL », et définissez le Type sur la valeur par défaut.

4. Entrez https://apihub.document360.io les champs INITIAL VALUE et CURRENT VALUE pour l’URL de base.

5. Cliquez sur le bouton Enregistrer .

   L’authentification du projet est terminée. Vous pouvez désormais facilement accéder à tous les points de terminaison disponibles et effectuer diverses actions.

   

Cas d’utilisation

Avec l’aide de Postman, vous pouvez effectuer diverses actions dans Document360.

Voici quelques cas d’usage de base pour votre référence

• Comment créer et publier un article ?

• Comment mettre à jour un article publié ?

• Comment mettre à jour les détails SEO ?

FAQ