Application API

All application API calls use the base URL https://api.starprinter.online/v1/a.

Device Groups

The Device Groups API allows you to retrieve information about, and configure tour Device Groups.

Method	Path	Action	Required permissions
GET	/v1/a	List Device Groups	ViewDeviceGroups
POST	/v1/a	Create New Device Group	CreateDeviceGroups
GET	/v1/a/{groupPath}	Fetch Device Group info	ViewDeviceGroups
PUT	/v1/a/{groupPath}	Update Device Group	ModifyDeviceGroups
DELETE	/v1/a/{groupPath}	Delete Device Group	DeleteDeviceGroups

Devices

The Devices API allows you to retrieve information about devices connected to a Device Group, such as status, as well as update device settings.

Method	Path	Action	Required Permissions
GET	/v1/a/{groupPath}/d	List devices	EnumDevices
GET	/v1/a/{groupPath}/d/{appId}	Fetch a device	ViewDevice
PUT	/v1/a/{groupPath}/d/{appId}	Update a device	ModifyDevice
DELETE	/v1/a/{groupPath}/d/{appId}	Delete a device	DeleteDevice

This API may be used to monitor your devices, but it is suggested to use webhooks to keep track of device status rather than frequently polling the API.

Print Queue

Use the Print Queue API to manage a devices print jobs.

Method	Path	Action	Required permissions
POST	/v1/a/{groupPath}/d/{appId}/q	Print a document	PrintToDevice
DELETE	/v1/a/{groupPath}/d/{appId}/q	Empty the print queue	FlushQueue
PUT	/v1/a/{groupPath}/d/{appId}/welcome	Print welcome page	PrintToDevice

Notifications

Use the Notifications API to manage Webhook notifications.

Method	Path	Action	Required permissions
GET	/v1/a/{groupPath}/n	List notifications	ManageNotifications
POST	/v1/a/{groupPath}/n	Add a notification	ManageNotifications
GET	/v1/a/{groupPath}/n/{notificationId}	Fetch notification	ManageNotifications
PUT	/v1/a/{groupPath}/n/{notificationId}	Update notification	ManageNotifications
DELETE	/v1/a/{groupPath}/n/{notificationId}	Delete notification target	ManageNotifications
GET	/v1/a/{groupPath}/n/test/{notificationId}	Test notification	ManageNotifications

Legacy Keyless Printing API

A previous printing API which allows printing without an API key, depending ot the printer Application Access ID for authentication is available for compatibility. This API may be disabled per Device Group and will be disabled by default for future Device Groups.

Method	Path	Action
POST	/application/job/{groupPath}-{appId}	Print a document