1. Home
  2. Cloud REST API

Cloud REST API

The Cloud REST API gives access to your complete production infrastructure that is linked to your company its account.

The API defines an interface to the following elements:

  • Jobs
  • Documents
  • Resources
  • Configuration
  • Nester
  • Logs

Jobs

Jobs can refer to one or more documents and to resources. The job contains the document list and optionally the imposition schema (layout), print mode, operations (workflow steps) and other specific instructions for the printer or cutter. For more information about the job structure refer to the job documentation.

Resources

Resources are items like labels, calibrations, templates, etc. The resources are versioned and its history is retained for 30 days. Jobs, documents and devices are not versioned and modifications are immediate.

Configurations

Configuration contains of devices, queues and RIPs.
Devices are the printers and cutters as available to the account. Devices are assigned to sites, which are identified by the site serial number. Moving devices from one site to another and site management is only available in the cloud-UI. Moving devices between RIPs and set-up of the devices is available through the API.
Queues are local automated processes, that are also accessible via local hotfolders. Jobs can be send directly to the device when the are production ready and contain an imposition and print-mode. Alternatively they can be send to a queue first, who will execute the defined pre-processing steps, including creating an imposition and setting the print-mode.
RIPs are individual computers that perform the heavy weight lifting and executes all instructions in the job, renders it to the resolution and ink-set of the printer, performs color management and encodes to the format accepted by the device.

Nesting

Automation describes the cloud based nesting, thus before assigning it to a device or site. The cloud based nesting allows to define JIT-nesting and job processing.

The REST calls are made over HTTP to api.aurelon.com in all regions besides China, where api.aurelon.cn is to be used. To authenticate the calling application specific headers are required. Information about the authentication can be found in the chapter Authentication.

Feedback on the status of jobs and devices after they have been created using the REST API are send using a WebSocket server. After opening a WebSocket connection your application can subscribe to the events its want to receive and will get those events through this channel.

API Documentation

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  

Examples

Below several samples of jobs that invoke late-binding functions in the RIP or simply put a document in the workflow as well as JavaScript and C# samples how to connect to the API.

XML Job Examples

  • Basic : Most basic job example to submit a single file
  • Multi-file : Submitting multiple files in one job
  • Finishing : Adding Folds, bleeds and grommets to a job

API Examples

  • JavaScript Sample : JavaScript example showing how to create documents, jobs and receive messages back from the server. The sample is build on node.js but can be used in other environments too.
  • C# Sample : API REST Client and WebSocket Client. Generates in C# the code to use for connecting.
Updated on August 16, 2019

Was this article helpful?