クライアント HTTP リクエストヘッダー
Star CloudPRNTクライアント/サーバー間の通信において、印刷ジョブの生成に関連する情報やデバイス情報の確認をリクエストヘッダーにてサーバーで確認できるように、いくつかの標準およびカスタムのhttpリクエストヘッダーを提供します。なお、これらはStar CloudPRNT通信を利用するために必須のものではないため、必要に応じてご利用ください。
サポートヘッダーリスト
以下の追加ヘッダーは、CloudPRNTクライアントからCloudPRNTサーバーへHTTPリクエストが発行されたときのHTTPヘッダーにて通知されます。
対応機種ファームウェアバージョン:
| Device Name | FW Version |
|---|---|
| mC-Print2/3 | 3.2以上 |
| TSP100IV | 1.0以上 |
| TSP100IV SK | 2.0以上 |
| mC-Label3 | 1.0以上 |
リクエストヘッダー一覧:
| Header | Request | Description |
|---|---|---|
| User-Agent | GET, DELETE, POST | User-Agent ヘッダーは、CloudPRNTクライアントから発行される全てのHTTPリクエストに含まれます。 User-Agentにて表示される文字列は、以下を参照してください。 |
| Accept | GET | CloudPRNTクライアントがサポートしている印刷ジョブのメディアタイプをサーバーに通知するためのHTTP/1.1標準のヘッダーです。 CloudPRNTクライアントから通知されるAccept文字列の例は、以下を参照してください。 |
| X-Star-Paper-Width | GET | 印字用紙幅(mm単位)について、ClientActionのPageInfoにおける"paperWidth" パラメーターと同等の値を表示します。 (例) X-Star-Paper-Width: 80 |
| X-Star-Print-Width | GET | 印字領域(mm単位)について、ClientActionのPageInfoにおける"printWidth" パラメーターと同等の値を表示します。 (例) X-Star-Print-Width: 72 |
| X-Star-Horizontal-Resolution | GET | 水平方向のプリンタドット解像度(dots/mm)について、ClientActionのPageInfoにおける"horizontalResolution" パラメーターと同等の値を表示します。 (例) X-Star-Horizontal-Resolution: 8 |
| X-Star-Vertical-Resolution | GET | 垂直方向のプリンタドット解像度(dots/mm)について、ClientActionのPageInfoにおける"verticalResolution" パラメーターと同等の値を表示します。 (例) X-Star-Vertical-Resolution: 8 |
| X-Star-Accept-Codepages | GET | UTF-8を含むコードページ・文字エンコーディングについてCloudPRNTクライアントの状況を表示します。 表示される文字列の例は、以下を参照してください。 |
| X-Star-Token | GET, DELETE, POST | CloudPRNTサーバーのPOSTレスポンスにて、"jobToken"フィールドによりジョブトークン文字列が設定されている場合のみ、本ヘッダーが追加されサーバーがジョブを追跡するために指定したそのトークン文字列が表示されます。 なお、tokenクエリ文字列パラメーターもしくは、 "jobToken"フィールド値と同等の文字列となります。 (例) X-Star-Token: ab347d134abe4f5ba8be565d5b6378fc |
| X-Star-Serial-Number | GET, DELETE, POST | CloudPRNTクライアントのシリアルナンバーが利用可能な場合、本ヘッダーに16桁の数値を文字列として表示します。もしシリアルナンバーが利用不可(未割当て)の場合、"n/a"文字列が表示されます。 (例) X-Star-Serial-Number: 2602319010600001 |
| X-Star-Mac | GET, DELETE, POST | macクエリ文字列パラメーターもしくは、"printerMAC"フィールド値と同等の文字列が表示されます。 (例) X-Star-Mac: 00:11:62:1d:e8:30 |
| X-Star-Id | GET, DELETE, POST | CloudPRNTサーバーのPOSTレスポンスにて、ClientAction(SetID)により任意のIDが設定されている場合のみ、本ヘッダーが追加されそのID文字列が表示されます。なお、uidクエリ文字列パラメータもしくは、"uniqueID"フィールドと同等の文字列が表示されます。 (例) X-Star-Id: Printer1 |
以下の追加ヘッダーは、メディアタイプが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 | 印刷ジョブ完了確認におけるfirmware クエリパラメーターと同等の値を表示します。 (例) X-Star-Configuration-Firmware-Result: success |
| X-Star-Configuration-Config-Result | DELETE | 印刷ジョブ完了確認におけるconfig クエリパラメーターと同等の値を表示します。 (例) X-Star-Configuration-Config-Result: success |
| X-Star-Configuration-Skip-Total | DELETE | 印刷ジョブ完了確認におけるskip クエリパラメーターと同等の値を表示します。(例) X-Star-Configuration-Skip-Total: 0 |
| X-Star-Configuration-Error-Total | 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) |
例) User-Agent: CloudPRNT/3.0 mC-Print3/3.2
Accept
Acceptは標準HTTP/1.1ヘッダーで、レスポンスで受け入れ可能なメディアタイプを指定するために使われます。CloudPRNTサーバーから印刷ジョブを取得するためにHTTP GETリクエストを行う際に有効なメディアタイプが含まれており、サポートされているすべてのメディアタイプの重み付けされたリストを提供します。印刷ジョブのフォーマットを決定するためのClientAction(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 |
品質係数(q)は、RFC2616 14.1 Acceptの章に基づいております。
例) Accept: 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
X-Star-Accept-Codepages
このヘッダーは、サーバーがテキストベースの文書を正しく事前にエンコードできるようにするためにクライアントから提供されます。 主な目的は、クライアントがUTF-8エンコーディングをサポートしているかどうかを識別することです。
サポートしている値は以下になります:
- utf8 - クライアントは、コードページ設定についてUTF-8が有効になっています。
- dbcs - クライアントは仕向地設定がDBCSです(具体的なコードページは認識できません)。UTF-8が有効な場合、全角優先設定を表します。
- std - クライアントは仕向地設定がSBCSです(具体的なコードページは認識できません)。UTF-8が有効な場合、半角優先設定を表します。
- none - クライアントは画像印刷のみをサポートしています。(現行機種では存在しません)
なお、複数の値を","を用いて提供される場合があります。
例) X-Star-Accept-Codepages: utf8,std