Automation of BarTender by using the BarTender REST API should be performed by programmers who are familiar with REST APIs.
Using the BarTender REST API |
The BarTender REST API provides REST endpoints that you can use to automate your system on a non-Windows platform or across the network by using the YAML or JSON file format or an existing legacy BTXML script. By using the BarTender REST API, you can use most types of programming languages, including C#, Java, Perl, or Python, and most integrated development environments (IDEs) to create your automation scripts.
|
|
Automation of BarTender by using the BarTender REST API should be performed by programmers who are familiar with REST APIs. |
The BarTender REST API uses the same BarTender Integration service and Print Scheduler service that are used by Integration Builder and Process Builder. Communication with the server occurs over port 5159.
For sending scripts and receiving responses, the API supports data payloads in JSON, YAML, and BTXML formats. A YAML reference document is included in the BarTender installation; for more information, refer to Available Actions in the Actions API. For more information about BTXML, refer to
The API supports the following technologies:
Cross-Origin Resource Sharing (CORS) so that the REST endpoints can be accessed from websites that originate anywhere
Several authentication schemes, including Basic Authentication, Integrated Authentication (Microsoft Negotiate), and Windows Challenge/Response (NTLM)
|
|
For security purposes, Basic Authentication is disabled by default. You can enable Basic Authentication by changing its setting to "true" in the appsettings.json configuration file. This file is installed in the following directory: C:\Program Files\Seagull\BarTender 2022\net6.0 |
Secure HTTPS
To use the BarTender REST API, the following conditions are required:
You are running the Automation or Enterprise edition of BarTender 2022.
Port 5159 is open so that the API can receive the REST commands.
You have permissions to sign in to the server and to administer integrations as configured in Administration Console.
Accessing the API for Endpoint Documentation and Testing
Describes the applications that you can use to access the BarTender REST API and to test your automation scripts.
Describes the BarTender REST API commands that you can use to create your scripts and provides code samples.