Connection and usage guides

What do you want your printer to do?

From online orders and self-service printing to embedded modules: find your use case, then follow the setup steps and API references.

Developer Docs

This article has no published English version yet. Browse the available English references below, or contact technical support.

You do not need to read every page. Pick your goal and follow its references. Already integrating? Search for signing, queues, callbacks or an API name.

Print orders from your website or app

Send an order to a printer and show its progress and result to your customer.

See setup and usage steps6references

Before you startPrepare a connected printer, its ID and key, an accessible image URL and physical print dimensions. Keep the key on your server.

  1. Sign the requestAuthenticate requests using the device credentials.Generate Signature
  2. Check printer availabilityCheck whether the device is offline, idle, printing, faulty or under maintenance.Check Printer Status
  3. Submit your first print jobSend the order ID, image and dimensions, then save the task ID.Send Print Job [Single Order]
  4. Confirm start when requiredOnly for devices configured to require a second confirmation.Start Print Job [Confirmation]
  5. Check this jobUse the task ID to check queue status, progress and creation, start and finish times.Query a Specific Print Job
  6. Receive print updatesProvide a callback endpoint in your system to receive completion and error updates.Print Task Callback

Keep in mindSubmission is not completion. Save the returned task ID. Call Start Print only when the device requires a second confirmation.

Browse all references · API | Internet →

Run a self-service printer

Let customers place orders while the kiosk prints them and reports the results to your system.

See setup and usage steps2references

Before you startConfirm the kiosk client version, product and channel setup, inventory and callback endpoint. Channels apply only to supported self-service devices.

  1. Receive job and dispensing updatesHandle completion, pause, failure and dispensing using the V2 definitions.Print Task Callback V2 [For Self-Service Kiosks Only]
  2. Receive device alertsRoute device, stock and ink alerts to the operator.Printer Status Callback V2 [For Self-Service Kiosks]

Keep in mindV2 and legacy callbacks use different status values. Confirm the required client version before using V2.

Browse all references · Interface - Internet (Self-service Machine) →

Troubleshooting and job controls

A request fails authenticationCheck the device ID, key, nonce and timestamp.Generate Signature →An order has not printedCheck whether the job is queued, printing, cancelled or faulty.Query a Specific Print Job →The printer is unavailableCheck offline, maintenance and fault status.Check Printer Status →Cancel this print orderCancel the specified print job. This is not a payment-refund operation.Cancel Specified Print Job →

How to read an API reference

  1. Check applicabilityCheck the device type, client version and integration type, especially kiosk-only features and V2 callbacks.
  2. Read the request and parametersUse the exact endpoint, method and required fields. Parameter names such as taskid and task_id vary by API.
  3. Check responses and updatesCheck the business result, not just HTTP success. Job status, device status and callback versions use different values.

Need an account or unsure which integration your device supports? Tell support your model, intended workflow and issue before you start.

Have an account? Check your devices in the console →

This page lists currently published English references only. For local protocols, AI or a missing manual, ask technical support for the appropriate documentation.