Using the Print Portal REST API

The Print Portal REST API is provided to support your needs for Print Portal automation. By using automation, you can integrate Print Portal with other applications to programmatically complete many Print Portal functions.

Automation of Print Portal by using the Print Portal REST API should be performed by programmers who are familiar with REST APIs and JavaScript Object Notation (JSON) format.

The help topics that are provided here include a high-level explanation and a simple end-to-end tutorial, from authentication to printing a BarTender document, that is intended to assist programmers in accomplishing these tasks with the least amount of time and effort. The documentation does not include an exhaustive list of functions and explanations, because this information is available in the API contents, which you can view in the Swagger user interface.

To view the Swagger user interface, add "swagger" after "BarTender" in the BarTender URI, as follows:

http://localhost/BarTender/swagger/

The Print Portal REST API includes a limited set of functions and provides support for you to automate the following tasks: 

To help you get started, a tutorial is provided to guide you through each of these API functions.

In This Section