Configure API Print Service

The Vasion Print (formerly PrinterLogic) API Print Service 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

• You must have a functional Service Client that meets the minimum required specifications. See Service Client.

  Running IPv6 on your Windows Service Client may cause conflicts. You may need to disable IPv6 on the Service Client's network adapter to resolve the conflict.

• Your Service Client must be able to access https://agent-api.app.printercloud.com/.

  • If you are also using Off-Network Print, your service client must be able to access the following:
    • ofn.app.printercloud.com
    • ofn-gw.app.printercloud.com
  Ensure you add the region code after printercloud, if applicable. Example: For Canada, add a 15 after printercloud: https://agent-api.app.printercloud15.com/, EMEA add a 5, APAC add a 10, Singapore add a 20.
• Have a certificate signed by a Certificate of Authority (CA) trusted by your source application.

Enable API Print Service

1. In the Admin Console, select the Service Client where you want to configure the API Print Service.
2. Select the Output Automation tab.

3. Enter the DNS Name of the Service Client you are using for Output Automation.

   

   This DNS name must match the device certificate name if using IPPS. The Service Client must map this DNS name to its local IP address. If this field is empty, the service will fail to start, and a "Failed to get host address" error is added 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.

      

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 Vasion Print (formerly PrinterLogic).

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

   

6. Select Save.

Certificate

You only need to employ a certificate trusted by the source application if you use IPPS. Follow the steps below:

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

   

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 Client.

      

   2. Enter Certificate — paste the contents of the certificate and key files into the corresponding text boxes.

      

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

Supported API Calls

Once configured, your source application can make RESTful API calls. Below is a brief overview. For complete schemas, see API Print Service Schemas

Print Job Request

Sends the file to be printed to the API Print Service along with metadata about the file that dictates where the job is sent, as well as color, duplex, and other finishing options.

Batch Open Request

Ensures certain files are printed in a specific order. Batch Open Request is used to begin the batch printing process and includes an ordered list of print job UUIDs and files.

Batch Close Request

Sent after a Batch Open Request and all associated files have been sent. Once a batch is closed, the files with UUIDs listed in the initial Batch Open Request are printed in the order the UUIDs were listed in the initial request.

Print Job Status

Once a job has been printed, or if it failed to print, the API Print Service will make a request back to the URL specified in the "statusURL" field as part of the initial print job request to inform the customer application on the status of the print job with the associated UUID.

Optional Next Step

• Configure High Availability.
• View the API Print Service Schemas.

Troubleshooting Help

printapi printstatusapi