Client HTTP Request Headers

Several standard and custom http headers can be provided to help Star CloudPRNT clients / servers negotiate document content correctly handle generation and transmitting documents.
And these are not mandatory to utilize Star CloudPRNT communication, so please use these as necessary.

Supported Headers List

These additional headers are included when making http requests from the client to the server.
Client firmware versions that support additional headers are:

Header

HI01X/02X Version (*1)

mC-Print2 Version (*2)

mC-Print3 Version (*2)

TSP100IV Version (*2)

TSP100IV SK Version (*2)

mC-Label3 Version (*2)

User-Agent

1.8

3.2

3.2

1.0

2.0

1.0

Accept

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Paper-Width

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Print-Width

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Horizontal-Resolution

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Vertical-Resolution

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Accept-Codepages

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Token

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Serial-Number

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Mac

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Id

1.8

3.2

3.2

1.0

2.0

1.0

X-Star-Support-Protocols

n/a

n/a

5.1

n/a

n/a

n/a
(*1) Minimum interface board firmware version.
(*2) Minimum printer firmware version.

Request header details

Header

Request

Description

User-Agent
Server setting information request (GET),
Print job requests (GET),
Print job confirmation (DELETE),
Polling the server (POST)
The User-Agent header is included for all client http requests.
The string for the User-Agent is shown in User-Agent .

Accept
Print job requests (GET)
The http/1.1 standard header to inform the server of media types for printing job supported by the client.
A table of Accept strings for CloudPRNT clients is shown in Accept .

X-Star-Paper-Width
Print job requests (GET)
Inform the paper width in mm. Equivalent of the "paperWidth" parameter for PageInfo at Client Action .
e.g.) X-Star-Paper-Width: 80

X-Star-Print-Width
Print job requests (GET)
Inform the print area width in mm. Equivalent of the "printWidth" parameter for PageInfo at Client Action .
e.g.) X-Star-Print-Width: 72

X-Star-Horizontal-Resolution
Print job requests (GET)
Inform the horizontal printer dot resolution in dots/mm. Equivalent of the "horizontalResolution"” parameter for PageInfo at Client Action . Note that this may not be a whole number integer (e.g. for dot-matrix models).
e.g.) X-Star-Horizontal-Resolution: 8

X-Star-Vertical-Resolution
Print job requests (GET)
Inform thevertical printer dot resolution in dots/mm. Equivalent of the "verticalResolution" parameter for PageInfo at Client Action . Note that this may not be a whole number integer (e.g. for dot-matrix models)
e.g.) X-Star-Vertical-Resolution: 8

X-Star-Accept-Codepages
Print job requests (GET)
Provide a list of codepages and text encodings supported by the device, including UTF-8.
The string for codepage is shown in X-Star-Accept-Codepages .

X-Star-Token
Print job requests (GET),
Print job confirmation (DELETE),
Polling the server (POST)
In the POST response of the CloudPRNT server, if a job token string is set by the “jobToken” field, then this header will be present and will be displayed the token that the server specified for tracking a job.
it is equivalent of the token query parameter or “jobToken” field parameter.
e.g.) X-Star-Token: ab347d134abe4f5ba8be565d5b6378fc

X-Star-Serial-Number
Server setting information request (GET),
Print job requests (GET),
Print job confirmation (DELETE),
Polling the server (POST)
The CloudPRNT client serial number if it is available (may depend on printer model, firmware version and production date).
If a serial number is not available then an "n/a" string response will be sent back.
e.g.) X-Star-Serial-Number: 2602319010600001

X-Star-Mac
Server setting information request (GET),
Print job requests (GET),
Print job confirmation (DELETE),
Polling the server (POST)
Equivalent of the mac query string parameter or “printerMAC” filed parameter.
e.g.) X-Star-Mac: 00:11:62:1d:e8:30

X-Star-Id
Server setting information request (GET),
Print job requests (GET),
Print job confirmation (DELETE),
Polling the server (POST)
Only included if an unique id has be configured for this device by Client Action (SetID) from the server.
Equivalent of the uid query string parameter or “uniqueID”.
e.g.) X-Star-Id: Printer1

X-Star-Support-Protocols
Server setting information request (GET),
Polling the server (POST)
Provide a list of the CloudPRNT communication protocols supported by the client.
e.g.) X-Star-Support-Protocols: HTTP,MQTT

Request headers related to application/vnd.star.starconfiguration

These additional request headers are given to DELETE requests after a job with mediaType of application/vnd.star.starconfiguration has been processed by the printer.

Supported Device Versions:

Device Name

FW Version

mC-Print2/3

3.5 or later

TSP100IV

1.0 or later

TSP100IV SK

2.0 or later

mC-Label3

1.0 or later

Request Header List:

Header

Request

Description

X-Star-Configuration-Firmware-Result
Print job confirmation (DELETE)
Equivalent of the firmware query parameter for Print job confirmation (DELETE) .
e.g.) X-Star-Configuration-Firmware-Result: success

X-Star-Configuration-Config-Result
Print job confirmation (DELETE)
Equivalent of the config query parameter for Print job confirmation (DELETE) .
e.g.) X-Star-Configuration-Config-Result: success

X-Star-Configuration-Skip-Total
Print job confirmation (DELETE)
Equivalent of the skip query parameter for Print job confirmation (DELETE) .
e.g.) X-Star-Configuration-Skip-Total: 0

X-Star-Configuration-Error-Total
Print job confirmation (DELETE)
Equivalent of the error query parameter for Print job confirmation (DELETE) .
e.g.) X-Star-Configuration-Error-Total: 0

User-Agent

This can be used by the server to identify the client type and supported CloudPRNT version, but is primarily useful for configuring network traffic filters.

Client

User-Agent string

mC-Print2

CloudPRNT/X.X mC-Print2/X.X (X is numeric)

mC-Print3

CloudPRNT/X.X mC-Print3/X.X (X is numeric)

TSP100IV

CloudPRNT/X.X TSP100IV/X.X (X is numeric)

TSP100IV SK

CloudPRNT/X.X TSP100IVSK/X.X (X is numeric)

mC-Label3

CloudPRNT/X.X mC-Label3/X.X (X is numeric)

IFBD-HI01X/HI02X

CloudPRNT/X.X HI01X02X/X.X.X (X is numeric)

e.g.) User-Agent: CloudPRNT/3.0 HI01X02X/1.8.0

Accept

Accept is a standard http/1.1 header used to enable content negotiation between a client and server.
And it is included a valid Accept header when making an http GET request to retrieve a print job from a server.
This provides a weighted list of all supported media types, and may be used by the server as an alternative to following the result of Client Action (Encodings) in POST request field or type of GET query parameter to determine the print job format.
Usually, the Accept header will be fixed for a particular client, and would be the same in all GET requests.

The informed values for current CloudPRNT client devices are:

Client

Accept string

mC-Print2/3 (Ver.3.4 or earlier)

application/vnd.star.starprnt, application/vnd.star.starprntcore; q=0.9, image/png; q=0.1, text/plain; q=0.7, image/vnd.star.png;mono_len=2400;24bpp_len=400; q=0.3

mC-Print2/3 (Ver.3.5 or later)

application/vnd.star.starprnt, application/vnd.star.starconfiguration, application/vnd.star.starprntcore; q=0.9, image/png; q=0.1, text/plain; q=0.7, image/vnd.star.png;mono_len=2400;24bpp_len=400; q=0.3

TSP100IV (Ver.1.0 or later)

application/vnd.star.starprnt, application/vnd.star.starconfiguration, application/vnd.star.starprntcore; q=0.9, image/png; q=0.1, text/plain; q=0.7, image/vnd.star.png;mono_len=2400;24bpp_len=400; q=0.3

TSP100IV SK (Ver.2.0 or later)

application/vnd.star.starprnt, application/vnd.star.starconfiguration, application/vnd.star.starprntcore; q=0.9, image/png; q=0.1, text/plain; q=0.7, image/vnd.star.png;mono_len=2400;24bpp_len=400; q=0.3

mC-Label3 (Ver.1.0 or later)

application/vnd.star.starprnt, application/vnd.star.starconfiguration, application/vnd.star.starprntcore; q=0.9, image/png; q=0.8, image/jpeg; q=0.8, text/plain; q=0.7, image/vnd.star.png;mono_len=2400;24bpp_len=400; q=0.3

IFBD-HI01X/02X with thermal Line Mode printer

application/vnd.star.line, application/vnd.star.raster, application/vnd.star.starprntcore; q=0.9, image/jpeg; q=0.8, image/png; q=0.8, text/plain; q=0.7

IFBD-HI01X/02X with dot-matrix Line Mode printer

application/vnd.star.linematrix, image/jpeg; q=0.8, image/png; q=0.8, text/plain; q=0.7

X-Star-Accept-Codepages

This header is provided by the client to allow the server to pre-encode text based documents correctly.
Primary goals are to know whether the target device supports UTF-8 encoding, and if so which languages can be supported.

Supported values are:

  • utf8
    The device supports UTF8 encoding, for example TSP650II
  • dbcs
    The client device is in DBCS mode, note that Star printers can not report which DBCS font data is installed.
  • std
    The standard code pages for the chosen emulation are supported.
  • none
    The client device which is like only bit-image printing does not support any device fonts (There is no model at this time).
Multiple values may be provided, with a comma separator.
e.g.) X-Star-Accept-Codepages: utf8,std