Einführung

Ab BarTender 2021 können Entwickler jetzt über eine umfassende Sammlung von REST-APIs mit dem Print Portal interagieren. Die meisten Vorgänge können über unsere REST-API durchgeführt werden, um Benutzer zu authentifizieren, vorhandene Ordner, Etiketten und Drucker aufzulisten sowie Etiketten zu drucken, indem Sie Abfragen stellen und die Ergebnisse als JSON abrufen.

Dieser Artikel bietet einen kurzen Überblick über die Print Portal REST-APIs. Er führt Sie durch die Authentifizierungsmethode der REST-API und zeigt, wie Sie das Swagger-Tool für API-Tests verwenden können.

Endpoints und Methoden

Die Print Portal REST-API ist nach RESTful-Prinzipien aufgebaut und unterstützt daher die beiden gängigsten HTTP-Methoden: GET und POST.  

Die Print Portal REST-API bietet Zugriff auf Ressourcen über Endpoint-URIs. Alle Print Portal API-Endpunkte haben folgende Basis-URL:

{Print Portal Basis-URL}/BarTender 

Für REST-API-Anfragen muss ein spezifischer Endpoint verwendet werden. Print Portal API V1 besteht aus 4 Endpunkten, die wie folgt gruppiert sind:

Tabelle 1-1 Print Portal REST-API Endpunkte und Methoden.

/api/v1/Authenticate

/api/v1/print

/api/v1/libraries/{id}

/api/v1/printers/{printerName}

Authentifizierung 

Wenn die Authentifizierung aktiviert ist, muss eine Anfrage von einem authentifizierten Benutzer stammen, bevor auf Print Portal-Ressourcen zugegriffen werden kann. Bei Erfolg wird ein Token zurückgegeben. 

Um ein Authentifizierungs-Token zu generieren, senden Sie eine POST -Anfrage an

{Print Portal Basis-URL}/BarTender/api/v1/Authenticate

mit folgendem Anfrage-Body:

{
 "userName": "UserName@Domain",
 "password": "Password"
}

Dies gibt eine JSON-Benutzerstruktur zurück, die eine token Eigenschaft enthält:

{
 "success": true,
 "token": "string",
 "expires_in": 0
}

Bei allen zukünftigen REST-API-Anfragen muss im Header Authorization folgendes Format verwendet werden:

Authorization: Bearer <TokenString>

Erste Schritte mit Swagger UI

Print Portal enthält außerdem ein REST-API-Spezifikationssystem namens Swagger. Mit Swagger UI können Sie die Ressourcen der API visualisieren und mit ihnen interagieren, ohne dass die Implementierungslogik vorhanden sein muss. Sie können Swagger als Hilfesystem für die REST-API betrachten, das Erklärungen, eine Ausführungsumgebung zum Testen von Anfragen und Erläuterungen zu jeder Funktion bietet.  

Swagger ist zugänglich, indem Sie nach BarTender in der Print Portal Basis-URL einfach swagger anhängen, zum Beispiel:

{Print Portal Basis-URL}/BarTender/swagger/

Die Swagger-Oberfläche ist in zwei Bereiche unterteilt, was wichtig ist, um die richtigen Informationen zu finden. Im oberen Bereich finden Sie Erklärungen zu den API-Funktionen und die Möglichkeit, API-Anfragen testweise auszuführen. Der untere Bereich mit dem Titel „Models“ bietet eine Erklärung zu jeder Funktion und deren Anforderungen.

Wie bereits erwähnt, bietet Swagger UI zeitsparende Funktionen, die das Testen einer API bei der Bereitstellung einfach und unkompliziert machen. Zum Beispiel können Sie für die Authentifizierung den entsprechenden oberen Eintrag ausklappen, um die Authentifizierungsanforderungen einzusehen.

Klicken Sie auf die Schaltfläche „Try it out“ und geben Sie Ihren Benutzernamen und Ihr Passwort im folgenden Format ein:

Klicken Sie anschließend auf den großen blauen Execute-Button:

Wenn die PrintPortal-Authentifizierung aktiviert ist und der richtige Benutzername sowie das richtige Passwort eingegeben wurden, wird ein Erfolg zurückgegeben und das Authentifizierungs-Token für zukünftige REST-API-Aufrufe angezeigt.

Weitere Informationen

Weitere Informationen, die Ihnen den Einstieg in die Automatisierung des Print Portals erleichtern, finden Sie im Print
Portal-Hilfesystem.