Wie Sie mit Postman den 4-Heights® Conversion Service kennenlernen können

Postman ist ein Tool zum Erstellen von HTTP-Anfragen, das Sie gratis herunterladen können. Es kann zum Testen und Kennenlernen jeder REST API, wie sie der 4-Heights® Conversion Service bietet, verwendet werden.

Das System einrichten

1. Laden Sie den 4-Heights® Conversion Service herunter und installieren Sie ihn.

2. Laden Sie Postman herunter und installieren Sie es.

3. Importieren Sie die Anfragen-Sammlung

  • Laden Sie die Collection herunter: Postman Collection
  • Öffnen Sie Postman und klicken Sie auf Import.
  • Ziehen Sie die heruntergeladene Collection auf den Importierdialog.
  • Klicken Sie auf 4-Heights® Conversion Service in der Collections Ansicht.

Ausprobieren

1. Stellen Sie zunächst sicher, dass die baseURL in Ihren Collection Variablen dem Host entspricht, auf dem Ihr 4-Heights® Conversion Service läuft.

2. Schauen Sie sich die verfügbaren Anfragen an: API Referenz

3. Um sich mit Postman vertraut zu machen, probieren Sie eine einfache Anfrage aus: listen Sie die verfügbaren Workflows auf (list available workflows).

  • Dies ist nützlich, um einen Überblick über verfügbare Workflows zu gewinnen.
  • Der Name eines Workflows kann dann beim Erstellen eines neuen Jobs als Eingabeparameter verwendet werden.

4. Verarbeiten Sie Ihre erste Datei (für mehr Informationen über den Jobverarbeitungsablauf, schauen Sie bitte das Kapitel "API Usage" im Handbuch an).

  • Create new job: Erstellen Sie einen neuen Job mit einem Workflow Ihrer Wahl.
    • Der Job ist erstellt und bereit für Daten.
    • Die ID des neu erstellten Jobs wird in der Collection Variable jobId gespeichert und automatisch für nachfolgende Anfragen verwendet.
  • Get job info: Rufen Sie die Job-Informationen ab um zu verifizieren, dass der Job tatsächlich erstellt wurde.
    • In der Antwort sollte stehen, dass der Status des Jobs "created" ist.
  • Add data to job: Fügen Sie Ihrem Job Daten hinzu (wählen Sie im Body-Tab ein Dokument aus).
    • Sie können diesen Schritt mehrmals mit verschiedenen Dateien wiederholen, um Ihrem Job weitere Daten hinzuzufügen.
  • Start job: Starten Sie den Job.
    • Der Conversion Service beginnt mit der Verarbeitung aller Dokumente, die Sie dem Job hinzugefügt haben.
  • Get job info: Rufen Sie die Job-Informationen erneut ab.
    • In der Antwort sollte nun stehen, dass der Status des Jobs "completed" ist (oder "processing", falls Sie grosse Dateien hinzugefügt haben und er die Verarbeitung noch nicht abgeschlossen hat).
  • Get job result: Rufen Sie das Job-Ergebnis ab um Informationen über das Verarbeitungsergebnis zu erhalten (wie z.B. Ereignisse, die während der Konvertierung stattgefunden haben).
    • Die ID des ersten Ergebnis-Datensets wird in der Collection Variable resultId gespeichert und automatisch in der nachfolgenden Anfrage verwendet.
    • Falls Ihr Workflow mehr als ein Ergebnis-Datenset zurückgibt, kopieren Sie alle IDs.
  • Get job result data: Rufen Sie die Job-Ergebnisdaten ab um das vom Conversion Service generierte Dokument zu erhalten.
    • Speichern Sie die Antwort als PDF-Datei, um sie anzuzeigen (klicken Sie rechts auf Save Response, dann Save to a file).
  • Delete job: Löschen Sie den Job um alle Ressourcen freizugeben, die für seine Bearbeitung verwendet wurden.
    • Alle mit dem Job verbundenen Collection Variablen werden zurückgesetzt.