クライアント HTTP リクエストヘッダー

Star CloudPRNTクライアント/サーバー間の通信において、印刷ジョブの生成に関連する情報やデバイス情報の確認をリクエストヘッダーにてサーバーで確認できるように、いくつかの標準およびカスタムのhttpリクエストヘッダーを提供します。
なお、これらはStar CloudPRNT通信を利用するために必須のものではないため、必要に応じてご利用ください。

サポートヘッダーリスト

以下の追加ヘッダーは、CloudPRNTクライアントからCloudPRNTサーバーへHTTPリクエストが発行されたときのHTTPヘッダーにて通知されます。
追加ヘッダーをサポートするクライアントのファームウェアバージョンは以下の通りです。

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) 最小インターフェースボードファームウェアバージョン
(*2) 最小プリンターファームウェアバージョン

リクエストヘッダー詳細

Header

Request

Description

User-Agent
サーバー設定情報取得リクエスト (GET),
印刷ジョブリクエスト (GET),
印刷ジョブ完了確認 (DELETE),
サーバーポーリング (POST)
User-Agent ヘッダーは、CloudPRNTクライアントから発行される全てのHTTPリクエストに含まれます。
User-Agentにて表示される文字列は、User-Agent を参照してください。

Accept
印刷ジョブリクエスト (GET)
CloudPRNTクライアントがサポートしている印刷ジョブのメディアタイプをサーバーに通知するためのHTTP/1.1標準のヘッダーです。
CloudPRNTクライアントから通知されるAccept文字列の例は、Accept を参照してください。

X-Star-Paper-Width
印刷ジョブリクエスト (GET)
印字用紙幅(mm単位)について、Client Action のPageInfoにおける "paperWidth" パラメーターと同等の値を表示します。
(例) X-Star-Paper-Width: 80

X-Star-Print-Width
印刷ジョブリクエスト (GET)
印字領域(mm単位)について、Client Action のPageInfoにおける "printWidth" パラメーターと同等の値を表示します。
(例) X-Star-Print-Width: 72

X-Star-Horizontal-Resolution
印刷ジョブリクエスト (GET)
水平方向のプリンタドット解像度(dots/mm)について、Client Action のPageInfoにおける "horizontalResolution" パラメーターと同等の値を表示します。
(例) X-Star-Horizontal-Resolution: 8

X-Star-Vertical-Resolution
印刷ジョブリクエスト (GET)
垂直方向のプリンタドット解像度(dots/mm)について、Client Action のPageInfoにおける "verticalResolution" パラメーターと同等の値を表示します。
(例) X-Star-Vertical-Resolution: 8

X-Star-Accept-Codepages
印刷ジョブリクエスト (GET)
UTF-8を含むコードページ・文字エンコーディングについてCloudPRNTクライアントの状況を表示します。
表示される文字列の例は、X-Star-Accept-Codepages を参照してください。

X-Star-Token
印刷ジョブリクエスト (GET),
印刷ジョブ完了確認 (DELETE),
サーバーポーリング (POST)
CloudPRNTサーバーのPOSTレスポンスにて、"jobToken" フィールドによりジョブトークン文字列が設定されている場合のみ、本ヘッダーが追加されサーバーがジョブを追跡するために指定したそのトークン文字列が表示されます。
なお、token クエリ文字列パラメーターもしくは、"jobToken" フィールド値と同等の文字列となります。
(例) X-Star-Token: ab347d134abe4f5ba8be565d5b6378fc

X-Star-Serial-Number
サーバー設定情報取得リクエスト (GET),
印刷ジョブリクエスト (GET),
印刷ジョブ完了確認 (DELETE),
サーバーポーリング (POST)
CloudPRNTクライアントのシリアルナンバーが利用可能な場合、本ヘッダーに16桁の数値を文字列として表示します。
もしシリアルナンバーが利用不可(未割当て)の場合、 "n/a" 文字列が表示されます。
(例) X-Star-Serial-Number: 2602319010600001

X-Star-Mac
サーバー設定情報取得リクエスト (GET),
印刷ジョブリクエスト (GET),
印刷ジョブ完了確認 (DELETE),
サーバーポーリング (POST)
mac クエリ文字列パラメーターもしくは、"printerMAC" フィールド値と同等の文字列が表示されます。
(例) X-Star-Mac: 00:11:62:1d:e8:30

X-Star-Id
サーバー設定情報取得リクエスト (GET),
印刷ジョブリクエスト (GET),
印刷ジョブ完了確認 (DELETE),
サーバーポーリング (POST)
CloudPRNTサーバーのPOSTレスポンスにて、Client Action (SetID)により任意のIDが設定されている場合のみ、本ヘッダーが追加されそのID文字列が表示されます。
なお、uid クエリ文字列パラメータもしくは、"uniqueID" フィールドと同等の文字列が表示されます。
(例) X-Star-Id: Printer1

X-Star-Support-Protocols
サーバー設定情報取得リクエスト (GET),
サーバーポーリング (POST)
クライアントがサポートするCloudPRNT通信プロトコルを表示します。
(例) X-Star-Support-Protocols: HTTP,MQTT

application/vnd.star.starconfigurationに関連するリクエストヘッダー

以下の追加ヘッダーは、メディアタイプがapplication/vnd.star.starconfigurationのジョブを、プリンターで処理した後のDELETE要求に付与されるリクエストヘッダーとなります。

対応機種ファームウェアバージョン:

Device Name

FW Version

mC-Print2/3

3.5以上

TSP100IV

1.0以上

TSP100IV SK

2.0以上

mC-Label3

1.0以上

リクエストヘッダー一覧:

Header

Request

Description

X-Star-Configuration-Firmware-Result
印刷ジョブ完了確認 (DELETE)
印刷ジョブ完了確認 (DELETE) における firmware クエリパラメーターと同等の値を表示します。
(例) X-Star-Configuration-Firmware-Result: success

X-Star-Configuration-Config-Result
印刷ジョブ完了確認 (DELETE)
印刷ジョブ完了確認 (DELETE) における config クエリパラメーターと同等の値を表示します。
(例) X-Star-Configuration-Config-Result: success

X-Star-Configuration-Skip-Total
印刷ジョブ完了確認 (DELETE)
印刷ジョブ完了確認 (DELETE) における skip クエリパラメーターと同等の値を表示します。
(例) X-Star-Configuration-Skip-Total: 0

X-Star-Configuration-Error-Total
印刷ジョブ完了確認 (DELETE)
印刷ジョブ完了確認 (DELETE) における error クエリパラメーターと同等の値を表示します。
(例) X-Star-Configuration-Error-Total: 0

User-Agent

本ヘッダーは、CloudPRNTサーバーがCloudPRNTクライアントの種類とサポートされているCloudPRNTのバージョンを識別するために使用することができますが、主にネットワークトラフィックのフィルター処理設定に役立ちます。

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)

例) User-Agent: CloudPRNT/3.0 mC-Print3/3.2

Accept

Acceptは標準HTTP/1.1ヘッダーで、レスポンスで受け入れ可能なメディアタイプを指定するために使われます。
CloudPRNTサーバーから印刷ジョブを取得するためにHTTP GETリクエストを行う際に有効なメディアタイプが含まれており、サポートされているすべてのメディアタイプの重み付けされたリストを提供します。
印刷ジョブのフォーマットを決定するための Client Action (Encodings)結果やGETクエリパラメーターのtypeの代わりに使用することもできます。
通常、AcceptヘッダーはCloudPRNTクライアント毎に固定で、すべてのGETリクエストで同じ値となります。

表示例は以下の通りです。:

Client

Accept string

mC-Print2/3 (Ver.3.4以下)

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以上)

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以上)

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以上)

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以上)

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

品質係数(q)は、RFC2616 14.1 Acceptの章に基づいております。

X-Star-Accept-Codepages

このヘッダーは、サーバーがテキストベースの文書を正しく事前にエンコードできるようにするためにクライアントから提供されます。
主な目的は、クライアントがUTF-8エンコーディングをサポートしているかどうかを識別することです。

サポートしている値は以下になります:

  • utf8
    クライアントは、コードページ設定についてUTF-8が有効になっています。
  • dbcs
    クライアントは仕向地設定がDBCSです(具体的なコードページは認識できません)。
    UTF-8が有効な場合、全角優先設定を表します。
  • std
    クライアントは仕向地設定がSBCSです(具体的なコードページは認識できません)。
    UTF-8が有効な場合、半角優先設定を表します。
  • none
    クライアントは画像印刷のみをサポートしています。(現行機種では存在しません)
なお、複数の値を","を用いて提供される場合があります。
例) X-Star-Accept-Codepages: utf8,std