Print a Document without requiring an API Key
Http Method: POST
URL Path: /application/job/{groupPath}-{appId}
Request Body Type: text/vnd.star.markup, text/html, text/plain, image/png, image/jpeg
Response Body Type: no response body
Required Permissions: PrintToDevice
Send a document to the print queue of a device. Jobs are printed, as soon as possible, in the order they enter the queue.
This API function can be called without requiring any caller based authentication, relying on the devices Application Access ID as security. This API method is primarily preserved for compatibility with existing applications, but may also be useful for applications which require only printing, and where the Application Access ID is considered to be enough security.
For most applications, it is recommended to use the API Key authenticated Print document method instead.
Note
If a devices Application Access ID has been leaked and is being abused by this API to generate unwanted print jobs, you can use the user Portal, or Update device API to assign a new ID.
Note
Future service updates will allow this API to be disabled on a per-group basis.
Request
Path Parameters
groupPath
The {groupPath} parameter provides the path identifier of the Device Group being accessed. This Device Group must be owned by the account authenticated by the calling API Key.
appId
The {appId} parameter provides the Application Access ID of the device being printed to.
Header and Query Parameters
Star-Job-Name / name
A name for the print job can be provided as a Star-Job-Name header, or star query parameter. This name will be used in any webhook event notifications which can be used to identify the result of printing this job.
Star-Copies / copies
A number of copies to be printed can be requested via the Star-Copies header, or copies query option. this can be a numerical value from 1 to 10.
If not provided, then the default number of copies for this device group will be used.
Star-Pre-Buzzer / startbuzzer
Request a number of times to sound a buzzer connected to the device, before printing the document. This can be controlled via the Star-Pre-Buzzer header, or startbuzzer query option as a numerical value from 0 to 3.
Star-Post-Buzzer / endbuzzer
Request a number of times to sound a buzzer connected to the device, after printing the document. This can be controlled via the Star-Post-Buzzer header, or endbuzzer query option as a numerical value from 0 to 3.
Note
All current Star CloudPRNT products require an external buzzer to be connected if sound is needed when printing.
Request Body
The Request body should be the raw data of the document to be printed, and should match the Content-Type header of your request.
Currently supported document formats are
- text/vnd.star.markup
- text/html
- text/plain
- image/png
- image/jpeg
Response
Return Codes
| Code | Description |
|---|---|
| 200 | Success, check the returned body data for the device list |
| 400 | BadRequest, unable to process the request, check calling path |
| 404 | Not Found, no device within the specified device group and owned by the authenticated account can be found. |
| 411 | Length Required |
| 415 | Unsupported Media Type |
| 500 | Server side error, such as inaccessible database. Please contact Star if this occurs frequently. |
Usage Example
An example, using curl to print a "Hello World" message using Star Document Markup, to a device with Application Access ID e9042f5f from a group with a path name of examplegroup.
curl -X POST -d'Hello World[cut]' --header "Content-Type: text/vnd.star.markup" https://beta.starprinter.online/application/job/examplegroup-e9042f5f