Qodex.ai

PrintFactory RIP API

Number of APIs: 50

This document describes the bi-directional communication between PrintFactory components and the RIP application that allows delivery of jobs, tracking of jobs and exchanging set-up parameters of the RIP.

The design pattern used is REST with WebHooks. Where the RIP has the server role and the other applications the client role.

Functionality

This document will be a living document; describing each version and adding future functionality. Therefore version/revision tracking are essential.

The API provides the following functionality for the exchange of data between the RIP and client applications:

  1. RIP server discovery
  2. Job delivery
  3. Printing progress tracking
  4. Error / cancel events from the printer
  5. Error / cancel events from the RIP
  6. Ink status and other printer health information

Discovery

RIP application responds to (broadcast) UDP packages sent to port 5437. The content of the datagram package to be send to the RIP(s) is:

ED730

Only RIPs with the corresponding version (in this case 720) will respond to the package. So newer and older (thus not compatible) versions of the RIP will not respond.

The response of the RIP needs to match the version number and have the RIP-prefix thus the content has to be:

RIP730

From the received package the sending IP address can be determined. At the given IP address at port 5438 the REST server will be listening to requests.

Note:

It is good practice to test the local-host interface and prefer that interface for local communication as the performance is much better than going through the Ethernet interface. Also the local interface can’t be influenced by network infrastructure changes.

  1. 6 Devices - 6.2 Device info GET http://{{rip_ip}}:5438/devices/{{device_id}}

  2. 6 Devices - 6.3 UI definition GET http://{{rip_ip}}:5438/devices/{{device_id}}/ui

  3. 6 Devices - 6.4 Labels GET http://{{rip_ip}}:5438/devices/{{device_id}}/labels

  4. 4 Web UI - 4.1 Web UI GET http://{{rip_ip}}:5438

  5. 6 Devices - 6.1 Device list GET http://{{rip_ip}}:5438/devices

  6. 6 Devices - 6.6 Queues GET http://{{rip_ip}}:5438/devices/{{device_id}}/queues

  7. 6 Devices - 6.7 Driver direct query POST http://{{rip_ip}}:5438/devices/{{device_id}}/query

  8. 6 Devices - 6.8 Medias sizes GET http://{{rip_ip}}:5438/devices/{{device_id}}/mediasizes

  9. 6 Devices - 6.9 Loaded media GET http://{{rip_ip}}:5438/devices/{{device_id}}/loadedmedia

  10. 6 Devices - 6.12 Set Media size compensation POST http://{{rip_ip}}:5438/devices/{{device_id}}/compensation/{{pmm_id}}