API Print Service

Last Updated: June 30, 2026

The PrinterLogic Application Programming Interface (API) Print Service A PrinterLogic Output connector that lets source systems send print jobs through web requests rather than traditional print queues or drivers. Running on a Service Agent, the API Print Service accepts representational state transfer (RESTful) API calls so apps that do not natively support printing can still print. provides printing capability from systems that don't typically support it by accepting print jobs via web requests. You can eliminate the need to install print queues on your source application and move to a driverless print model, reducing the work required to maintain the print environment.

Requirements

Ubuntu Service Agent

Customers with an Ubuntu (LTS) 22.04 Service Agent must run an additional command on the Service Agent after configuring the steps below. The command initializes the service.

Copy Code
sudo ln -s "$(cat /etc/pl_dir)/service_client/service-output-management/bin/libmako-adapter-lib.so" "$(cat /etc/pl_dir)/service_interface/lib/libmako-adapter-lib.so" 

Turn On the API Print Service

  1. In the Admin Console, select the Service Agent where you want to configure the API Print Service.
  2. Select the Output Automation tab.
  3. Enter the Domain Name of the Service Agent you are using for PrinterLogic Output.

    Admin Console, showing DNS Name section on Output Automation.

    This Domain Name must match the device certificate name and the Service Agent must map this Domain Name to its local IP address. If this field is empty, the service will fail to start, and adds a "Failed to get host address" to the log.

  4. Scroll down to the API & IPP Print Service section and select Enable API Print Service.

    1. The default port is 31990, but you can change this, if necessary.

      Admin Console, showing API & IPP Print Service section on Output Automation.

  5. If your application is secured, you can select Enable Basic Authentication to generate an authorization code or enter a code from your application to provide authorization to send jobs to PrinterLogic.

    1. If you have a code from your application, select and delete the generated code and enter your application's code.

    Admin Console, showing Authorization section on Output Automation.

  6. Select Save.

Certificate

You need a certificate only when you enable Transport Layer Security (TLS) on a service. You can enable TLS independently on the API Print Service and on the Internet Printing Protocol Secure (IPPS) service. When you enable TLS, the certificate must be trusted by the source application calling the service.

Follow the steps below to configure your certificate:

  1. Select Enable TLS on IPP(S) Service.

    Certificate section of the Output Automation tab showing the Enable TLS on IPP(S) Service option enabled.

  2. Enter the information for your certificate using one of the following options:

    1. Path to Certificate: Enter the file path to where your .pem and .key files are stored on the Service Agent.

      Path to certificate option in the Output Automation tab

    2. Enter Certificate: Paste the contents of the certificate and key files into the corresponding text boxes.

      Certificate window, showing options for entering information.

The Status section shows a green circle and states the service is Online when everything is configured correctly.

Output Automation service status

Supported API Calls

Once configured, your source application can make the RESTful API calls. For more details refer to API Print Service Schemas.

Optional Next Step

Troubleshooting Help