1. Cloud REST API

Cloud REST API

Our Cloud REST API creates the seamless link you need between PrintFactory’s features and your complete production infrastructure.
The API defines an interface to these elements:
  • Jobs
  • Documents
  • Resources
  • Configuration
  • Nesting
  • Logs

Jobs

‘Jobs’ refers to one or more documents and resources. A job contains the document list and may include the imposition schema (the layout), the print mode, operations (workflow steps) and other instructions you’d like to send to the printer or cutter.

There’s more information about job structure in job documentation.

Resources

Resources are things like labels, calibrations, and templates. They’re versioned, and a history of those versions is kept for 30 days. (Jobs, documents and devices don’t get versioned; any modifications you make are immediate.)

Configurations

Configurations hold devices, queues, and RIPs.

Devices are the printers and cutters associated with your account. Devices are assigned to sites, which are identified by a serial number. Moving devices from one site to another can only be done via the Cloud-UI. You can move devices between RIPs and set-up those devices through the API.

Queues are local, automated processes, which are also accessible via local hotfolders. Jobs can be sent directly to a device when they are production-ready, and when they contain an imposition and instructions about print-mode. (Or they can be sent to a queue first, which will carry out a set of defined pre-processing steps such as creating an imposition and setting the print-mode for you.)

RIPs are individual computers that do the heavyweight lifting. They carry out all the instructions for the job. That includes defining the right resolution and ink-settings for the printer, doing all the color management that’s necessary, and encoding instructions in the right format – the one that’s accepted by the device.

Nesting

Automation describes our cloud-based workflow and nesting feature, which happens before assigning jobs to a specific device or site. It’s cloud-based nesting that allows us to give you Just-in-Time-nesting and faster job processing.

The REST calls are made over HTTP to api.aurelon.com in all regions except China, where we use api.aurelon.cn. To authenticate the call, we need specific headers. You’ll find more information about authentication in Authentication.

Feedback on the status of jobs and devices you’ve created using the REST API are sent using a WebSocket server. After opening a WebSocket connection your application can subscribe to the events it wants to receive: they’ll be delivered through this channel.

The WebSocket provides consolidated feedback from all of your RIPs and devices, or, using Webhooks, you can get the same data from individual RIPs. In that case the XML report URL will be compiled according to your RIP preferences. Every event that’s sent to the cloud is also delivered as a POST call to that URL.

Element Resource URI
Configuration /api/v2/configuration
Job /api/v2/job
Document /api/v2/document
Resource /api/v2/resource
Log /api/v2/log
Nesting /api/v2/nester
Device /api/v2/device
Commands /api/v2/commands
WebSocket