User Manual Quickstart General Concepts Frame Features Resources Style Reference Change Log Glossary Acknowledgements Api Reference Authorization Tokens Embedding The Editor Custom Integration Backend Api Backend API

Backend API

Once a customer order is paid and ready for production one can order print-ready files with the help of the Printess Backend API.

token dialog

The preferred method would be that the shop backend or shop floor software calls our backend API (using the Service Token for authentication) and provide a callback url for the Printess backend. The function to call is /production/produce. The Printess Backend will return a JobID. Generally all documents which are marked as production documents are produced. If no document is marked for production the first document will get rendered.

Once the Printess backend has finished rendering of the highres file(s) for this document it will call the shop backend with the url(s) to the output file(s) or an error message in case there was a problem while rendering. If your endpoint is down for any reason the Printess backend will retry to deliver the callback up to 10 times with enlarging waiting time (The first 5 retries will be done after 5 minutes, the 6th after 15 minutes, the 7th after 1 hour, the 8th after 2 hours, the 9th after 4 hours and the 10th and last retry after 24 hours).

Additionally one can retrieve the status of a produce order by calling the function /production/status/get providing the JobID of the job one would like to get the status for. This is also best practice for all backend systems which get restarted and have jobs without final states in their databases as inbetween callbacks might have gotten lost or at least might be delayed (s.a.).

Please avoid loops in fast succession calling the status of a job for each started job, as this API method is throttled and might stall your system in case of many parallel jobs. Please use the callback method instead.

To make testing and integration of our order processing backend convinient we’ve created an OpenAPI for you, which can be used in Postman for example (and many more tools).

It is also possible to test the API endpoint directly on our swagger page - for backend testing please use your service token from the login menu in the editor (see Authorization chapter).

Follow this Link to our Swagger API page