Comment démarrer avec le 4-Heights® Conversion Service en utilisant Postman

Postman est un outil téléchargeable gratuitement permettant d'effectuer des requêtes HTTP. Il peut être utilisé pour tester et se familiariser avec toute API REST telle que celle proposée par le 4-Heights® Conversion Service.

Configurer le système

1. Téléchargez et installez le 4-Heights® Conversion Service.

2. Téléchargez et installez Postman.

3. Importez la collection de requêtes dans Postman

  • Télécharger la collection : Collection Postman
  • Ouvrez Postman et cliquez sur Importer.
  • Faites glisser la collection téléchargée vers la fenêtre d'importation.
  • Cliquez sur 4-Heights® Conversion Service dans la vue Collections.

Essayer

1. Tout d'abord, assurez-vous que le baseURL de vos variables de collecte spécifie l'hôte où s'exécute votre 4-Heights® Conversion Service.

2. Jetez un coup d'œil aux requêtes disponibles : Référence API

3. Pour vous familiariser avec Postman, essayez une requête simple : list available workflows.

  • Cette requête est utile pour obtenir un aperçu des flux de travail disponibles.
  • Le nom d'un flux de travail peut ensuite être utilisé comme paramètre d'entrée lors de la création d'un nouveau job.

4. Traitez votre premier fichier (pour plus d'informations sur la séquence de traitement des tâches, veuillez vous reporter à la section "API Usage" du manuel).

  • Create new job avec le workflow de votre choix.
    • Le job est créé et prêt à recevoir des données.
    • L'ID du travail créé est enregistré dans la variable de collection jobId et utilisé automatiquement pour les demandes suivantes.
  • Get job info pour vérifier qu'il a bien été créé.
    • La réponse devrait vous indiquer que le statut du job est "créé"/"created".
  • Add data to job Ajoutez des données au travail (choisissez le fichier dans l'onglet Body).
    • Vous pouvez répéter cette étape plusieurs fois avec des fichiers différents afin d'ajouter plus de données à votre travail.
  • Start job
    • Le Conversion Service commence à traiter tous les documents que vous avez ajoutés à la tâche.
  • Get job info encore une fois.
    • La réponse devrait maintenant vous indiquer que le statut du job est "completed" (ou "processing" si vous avez ajouté des fichiers volumineux et que le traitement n'est pas encore terminé).
  • Get job result pour recevoir des informations sur le résultat (comme les événements qui se sont produits pendant la conversion).
    • L'ID du premier ensemble de données de résultat est stocké dans la variable de collection resultId et utilisé automatiquement dans la demande suivante.
    • Si votre workflow renvoie plus d'un ensemble de données de résultat, copiez tous les ids.
  • Get job result data pour recevoir le document réel généré par le Conversion Service.
    • Enregistrez la réponse sous forme de fichier PDF pour la visualiser (cliquez sur Save Response, puis sur Save to a File dans la partie droite).
  • Delete job pour libérer les ressources utilisées pour son traitement.
    • Toutes les variables de la collection associées au job sont réinitialisées.