Die Benutzeroberfläche sowie die Dokumentation von Print Portal beschrieben Ursprungsordner. Dabei handelt es sich um die Ordner, die Sie konfigurierten, so dass sie in Print Portal verfügbar sind. In der REST API werden diese Ordner „Bibliotheken“ genannt. Der Unterschied wird Ihnen auffallen, wenn Sie eine Liste (oder Aufzählung) von Ursprungsordnern anfordern. Beim Aufzählen des Inhalts eines Ursprungsordners (Bibliothek) werden alle Unterordner und deren Bestandteile, sowohl Unterordner als auch Dokumente, aufgelistet.
REST API ist ein Art von Softwarearchitektur, mit der textuelle Repräsentationen des Inhalts von Webressourcen erlangt und bearbeitet werden. Die Print Portal- REST API stellt Daten im JSON-Format dar, also Daten, die im JSON-Format gesendet und ausgegeben werden.
Das Beispiel in diesem Tutorial beginnt mit URL-Anfragen und der Antwort. Dazu wird der Browser verwendet. Es gibt auch JavaScript-Beispiele für die programmatische Konstruktion von Anfragen.
Für die Schritte in diesem Tutorial befindet sich der Browser auf dem Client, auf dem auch Print Portal installiert ist, im URI-String wird also „localhost“ verwendet.
Print Portal enthält ein REST API-Spezifikationssystem namens Swagger. Swagger ist das Hilfesystem für die REST API, es bietet Erklärungen zu jeder Funktion und Ausführungsumgebungen für Testanforderungen.
|
|
To view the Swagger user interface, add "swagger" after "BarTender" in the BarTender URI, as follows: http://localhost/BarTender/swagger/ |
Die Ansicht von Swagger ist in zwei Hälften geteilt. Der obere Abschnitt enthält Erklärungen der API-Funktionen sowie die Möglichkeit, API-Anforderungen zu testen. Der untere Abschnitt namens Modelle enthält Erklärungen zu den Funktionen und ihren Anforderungen. Wenn Sie also wissen möchten, was printRequestID ist, klicken Sie im Abschnitt Modelle auf PrintRequest. Dann wird eine Liste mit Argumenten und deren Definitionen anzeigt, darunter printRequestID.