Verwendung der BarTender REST API |
Die BarTender REST API stellt REST-Endpunkte bereit, mit denen Sie Ihr System auf einer Nicht-Windows-Plattform oder in einem Netzwerk automatisieren können, indem Sie das YAML- oder JSON-Dateiformat oder ein bestehendes BTXML-Skript verwenden. Mithilfe der BarTender-REST API können Sie die meisten Programmiersprachen, einschließlich C#, Java, Perl und Python, sowie die meisten integrierten Entwicklungsumgebungen (IDEs) verwenden, um Ihre Automatisierungsskripte zu erstellen.
|
Die Automatisierung von BarTender mit der BarTender REST API sollte nur von Programmierern durchgeführt werden, die mit REST APIs vertraut sind. |
Die BarTender REST API verwendet denselben BarTender-Integrationsdienst sowie denselben Druckplanungsdienst wie der Integration Builder und der Process Builder. Die Kommunikation mit dem Server erfolgt über Port 5159.
Zum Versand von Skripten und dem Empfang von Antworten unterstützt die API Datennutzlasten im JSON-, YAML- und BTXML-Format. A YAML reference document is included in the BarTender installation; for more information, refer to Available Actions in the Actions API. Weitere Informationen über BTXML finden Sie unter
Die API unterstützt die folgenden Technologien:
Cross-Origin Resource Sharing (CORS), damit die REST-Endpunkte von Websites beliebigen Ursprungs aufgerufen werden können
Verschiedene Authentifizierungsschemas, einschließlich Basic Authentication, Integrated Authentication (Microsoft Negotiate) und Windows Challenge/Response (NTLM)
|
Aus Sicherheitsgründen ist Basic Authentication standardmäßig deaktiviert. Sie können Basic Authentication aktivieren, indem Sie die zugehörige Einstellung in der Konfigurationsdatei appsettings.json auf „true“ stellen. Sie finden die Datei in diesem Verzeichnis: C:\Program Files\Seagull\BarTender 2022\net6.0 |
Secure HTTPS
Zur Verwendung der BarTender REST API müssen folgende Voraussetzungen erfüllt sein:
Die Automation- oder Enterprise-Edition von BarTender 2022 wird ausgeführt.
Port 5159 ist geöffnet, sodass die API die REST-Befehle empfangen kann.
Sie haben die nötigen Berechtigungen in der Administration Console, um sich auf dem Server anzumelden und Integrationen zu verwalten.
Zugriff auf die API für Endpunktdokumentation und -tests
Beschreibt die Anwendungen, mit denen auf die BarTender REST API zugreifen und Ihre Automatisierungsskripte testen können.
Beschreibt die Befehle der BarTender REST API, die Sie zur Erstellung Ihrer Skripte verwenden können, und enthält Codebeispiele.