Comment utiliser Postman ?

Plans prenant en charge l’accès aux paramètres de jeton d’API dans le portail de la base de connaissances

Postman est une plate-forme API pour la création et l’utilisation d’API. Il est facile de lier votre projet Document360 à Postman et vous pouvez le faire en quelques minutes. Vous pouvez utiliser Postman sur site ou sur le Web.

NOTE

Pour plus d’informations sur l’application Postman, lisez les articles suivants.

• How to download Postman application?

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

• Comment utiliser Postman ?

• FAQs in Postman

Lier votre projet Document360 dans Postman

Les étapes ci-dessous sont basées sur l’application Postman locale.

1. Ouvrez l’application Postman.

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

   Une fenêtre contextuelle d’importation s’affiche.

3. Entrez l’URL ci-dessous dans le champ.
   https://apihub.document360.io/swagger/v2/swagger.json
   

   La fenêtre contextuelle Choisir comment importer votre API s’affiche avec deux options.

4. Sélectionnez l’option souhaitée

   • Collection Postman (par défaut)

   • OpenAPI 3.0 avec une collection Postman

5. Cliquez sur le bouton Importer .

   Une fois l’importation terminée, l’action créera un exemple de demande pour chaque point de terminaison, ce qui vous permettra d’effectuer la demande rapidement.
   

   

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

1. Dans l’arborescence, développez Document360 Customer API.

2. Sous l’onglet Autorisation, définissez le type d’authentification sur Clé API dans la liste déroulante.

3. Entrez la variable souhaitée dans le champ Clé .

4. Entrez le jeton d’API dans le champ Valeur. Pour générer un jeton API, lisez l’article sur Generating token.

   NOTE

   Génération d’un jeton d’API

   un. Accédez à Paramètres > portail de la base de connaissances > les jetons d’API.

   b. Créez le jeton d’API souhaité et copiez-le.

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

1. Dans la barre de navigation de gauche, accédez à Environnements.

2. Dans le volet 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 par défaut.

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

5. Cliquez sur le bouton Enregistrer .

   L’authentification du projet est terminée. Vous pouvez désormais accéder facilement à 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’utilisation de base à titre de référence

• Comment créer et publier un article ?

• Comment mettre à jour un article publié ?

• Comment mettre à jour les détails SEO ?

Foire aux questions