Print authorization

Using the REST API printing endpoints and Excel spreadsheet printing have no access restrictions by default, or to be more specific, print queues linked to specific printers do not have such restrictions by default. To have more control over who has access to printouts, you can use the queue security mechanism via API Key.

Securing printer queue

As mentioned earlier, the standard print queue created when adding a printer to the program is not protected against access. Consequently, any user with access to the REST API or an unsecured Excel spreadsheet file has the right to order printouts.

To prevent unauthorized printouts, you can set the API Key (or multiple API Keys) for the specific print queues. To do that, you need to visit the Authorization Managament page in the application’s menu and choose the API Keys submenu item.

You will see the list or printer queues. Pressing the last dropdown button in a row for a specific printer opens the panel with its API Keys list.

Add API Key

  1. open the Authorization Management / API Keys page and expand the API Keys panel for one of your printers
  2. click the Add API Key button
  3. provide some description that will help you identify this key in the future. After this step you will notice the new API Key entry (enabled by default)
  4. go back to the printer queue row and click the padlock icon in the Actions kolumn. You will notice that the padlock icon in the Security enabled column is active

On the screen you should see an API key and two active padlock icons. One for the key, the other for the print queue. The full API key value to be passed in the request header is not displayed here. To get it, use the “copy” button available next to it.

From now on, all print requests to this print queue will have to include the key just generated in their header.

Authorization of REST API printouts

Authorization of printouts made using the REST API print endpoints is done by adding the X-API-Key request header containing the value of the generated API key.

For more information please visit Secure printers with API Key section in this tutorial

Authorization of Excel printouts

Authorization of printouts made using an Excel spreadsheet is set when generating the Excel file. If the key changes, a new file should be generated with the current Api Key.

For more information please visit Practice printing using Excel section in this tutorial

Table of contents