Users Manual - WebConfig API
Page 5
... Symbols...3 ■ Restriction of Use ...3 ■ About this Manual ...4 Aim of the Manual ...4 Manual Content ...4 ■ Contents...5 Overview ...7 ■ Overview of WebConfig API 7 ■ Supported printers ...8 Support functions...8 Interface...8 ■ Usage Instructions ...9 Acquisition and Configuration of Setting Values 9 Digest authentication...11 ■ Restrictions...12 Web API Specification 13 ■ URL of...
... Symbols...3 ■ Restriction of Use ...3 ■ About this Manual ...4 Aim of the Manual ...4 Manual Content ...4 ■ Contents...5 Overview ...7 ■ Overview of WebConfig API 7 ■ Supported printers ...8 Support functions...8 Interface...8 ■ Usage Instructions ...9 Acquisition and Configuration of Setting Values 9 Digest authentication...11 ■ Restrictions...12 Web API Specification 13 ■ URL of...
Users Manual - WebConfig API
Page 6
■ Characters...19 Character Code...19 Escape Sequence ...19 Passwords...19 ■ Operation specifications...19 Printer Response Time ...19 ■ Example of Request and Response 20 Reference...23 6
■ Characters...19 Character Code...19 Escape Sequence ...19 Passwords...19 ■ Operation specifications...19 Printer Response Time ...19 ■ Example of Request and Response 20 Reference...23 6
Users Manual - WebConfig API
Page 7
It uses the GET and PUT methods defined in HTTP to configure TM printers via the web. Chapter 1 Overview Overview Overview of WebConfig API WebConfig API is an API used . It is mainly used to modify settings, and these settings are applied after being incorporated into customer applications. The PUT method is used after the printer is used to retrieve and modify setting values over HTTPS. The JSON data format is reset. 1 GET method PUT method 7
It uses the GET and PUT methods defined in HTTP to configure TM printers via the web. Chapter 1 Overview Overview Overview of WebConfig API WebConfig API is an API used . It is mainly used to modify settings, and these settings are applied after being incorporated into customer applications. The PUT method is used after the printer is used to retrieve and modify setting values over HTTPS. The JSON data format is reset. 1 GET method PUT method 7
Users Manual - WebConfig API
Page 8
Supported printers TM-T88VI Firmware Ver.40.02 ESC/POS or later TM-T88VI-iHUB Support functions Functions supported by the WebConfigAPI are as follows. TM intelligent function Not supported functions: Customize Value Memory Switches Network settings Interface Wired LAN Wireless LAN 8
Supported printers TM-T88VI Firmware Ver.40.02 ESC/POS or later TM-T88VI-iHUB Support functions Functions supported by the WebConfigAPI are as follows. TM intelligent function Not supported functions: Customize Value Memory Switches Network settings Interface Wired LAN Wireless LAN 8
Users Manual - WebConfig API
Page 9
...or creation of data) 3 : Set values are sent to the printer 4 : Check that the "message" in the parenthesis of the PUT response is "Success" and reset the printer. 5 : Reset the Printer 30 seconds 6 : Printer settings acquisition PUT Request(Set Values) PUT Response() Request() Response() GET... Request() GET Response(Set Values) Saving of set values Reset the Printer Rewriting setting values Returns specified values of ...
...or creation of data) 3 : Set values are sent to the printer 4 : Check that the "message" in the parenthesis of the PUT response is "Success" and reset the printer. 5 : Reset the Printer 30 seconds 6 : Printer settings acquisition PUT Request(Set Values) PUT Response() Request() Response() GET... Request() GET Response(Set Values) Saving of set values Reset the Printer Rewriting setting values Returns specified values of ...
Users Manual - WebConfig API
Page 10
...acquired by the PUT method. Specify the key and value, see "Reference" on page 23. Edit JSON data acquired from the printer are Sent to the Printer The specified JSON data is done using the GET method. Specify only the value of the specified key. "StatusNotification": { "...:// There are included in the body of the response. For example: Acquisition JSON data ... Acquisition of settings from the printer Firstly the settings from the printer. The setting values are two setting methods: You can specify only the value of each key value to acquire all data...
...acquired by the PUT method. Specify the key and value, see "Reference" on page 23. Edit JSON data acquired from the printer are Sent to the Printer The specified JSON data is done using the GET method. Specify only the value of the specified key. "StatusNotification": { "...:// There are included in the body of the response. For example: Acquisition JSON data ... Acquisition of settings from the printer Firstly the settings from the printer. The setting values are two setting methods: You can specify only the value of each key value to acquire all data...
Users Manual - WebConfig API
Page 11
Chapter 1 Overview Reset the Printer Simply sending setting values to apply any changes. After acquiring a PUT method response, the printer is reset in order to the printer does not change actual values on the printer. The printer needs to be reset for changes to be applied. https:///webconfig/api/v1/webconfig.cgi Acquire a specific key https://
Chapter 1 Overview Reset the Printer Simply sending setting values to apply any changes. After acquiring a PUT method response, the printer is reset in order to the printer does not change actual values on the printer. The printer needs to be reset for changes to be applied. https:///webconfig/api/v1/webconfig.cgi Acquire a specific key https://
Users Manual - WebConfig API
Page 13
Communicates the allowable request headers of cross- Allow-Methods: ● ● ● ● domain communication. charset=utf-8 Access-Control- Allow-Origin: domain communication if communication sources ● ● ● ● are also supported. 2 Response The following content is included in the header for permitting cross- Response Header Header HTTP Method GET PUT HEAD OPTIO NS Description Value Content-Type: - ● ● ● ● application/json; PUT, GET, OPTIONS, HEAD Access-Control- Specify "*" in the ...
Communicates the allowable request headers of cross- Allow-Methods: ● ● ● ● domain communication. charset=utf-8 Access-Control- Allow-Origin: domain communication if communication sources ● ● ● ● are also supported. 2 Response The following content is included in the header for permitting cross- Response Header Header HTTP Method GET PUT HEAD OPTIO NS Description Value Content-Type: - ● ● ● ● application/json; PUT, GET, OPTIONS, HEAD Access-Control- Specify "*" in the ...
Users Manual - WebConfig API
Page 14
...9679; Content-SecurityPolicy: ● WWW-Authenticate: ● HTTP Method Description PUT HEAD OPTIO NS Value Prevents the browser from the printer. mode=block Prevents clickjacking attacks. Digest realm="", nonce="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" Response Body HTTP Method GET PUT Description The setting ...values are not the setting values acquired from the printer. For details of these return values, see "GET method" on page 17. 14 These are returned from identifying...
...9679; Content-SecurityPolicy: ● WWW-Authenticate: ● HTTP Method Description PUT HEAD OPTIO NS Value Prevents the browser from the printer. mode=block Prevents clickjacking attacks. Digest realm="", nonce="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" Response Body HTTP Method GET PUT Description The setting ...values are not the setting values acquired from the printer. For details of these return values, see "GET method" on page 17. 14 These are returned from identifying...
Users Manual - WebConfig API
Page 15
..., see "GET method" on page 17. 15 Contains the values to configure the printer. charset=utf-8 Authorization: Digest username="epson" realm="ByPassword" nonce="xxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" ,,,,,, 2 Request Body HTTP Method GET PUT Description Acquires the current setting values from the printer. For details of these set values, see "PUT method" on page 16...
..., see "GET method" on page 17. 15 Contains the values to configure the printer. charset=utf-8 Authorization: Digest username="epson" realm="ByPassword" nonce="xxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" ,,,,,, 2 Request Body HTTP Method GET PUT Description Acquires the current setting values from the printer. For details of these set values, see "PUT method" on page 16...
Users Manual - WebConfig API
Page 16
...specific setting value: Specifies a keyname by the GET parameter. [format] keyname= If acquiring multiple setting values: Separating with the printer : The other than "keyname" is present. 401 Authentication Required As authentication is carried out by lighttpd. A keyname not found in GET... values. Repair is necessary if the problem occurs even after restarting the printer. 400 Bad Request { "Setting" : {}, "message": "Specified key is required. Value exists: Setting value was not possible because printer is returned by lighttpd, the response body is being used. { "...
...specific setting value: Specifies a keyname by the GET parameter. [format] keyname= If acquiring multiple setting values: Separating with the printer : The other than "keyname" is present. 401 Authentication Required As authentication is carried out by lighttpd. A keyname not found in GET... values. Repair is necessary if the problem occurs even after restarting the printer. 400 Bad Request { "Setting" : {}, "message": "Specified key is required. Value exists: Setting value was not possible because printer is returned by lighttpd, the response body is being used. { "...
Users Manual - WebConfig API
Page 17
... Entity Too For the maximum size of keyname and 200 OK value by the following way. { "Setting" : Updating was not possible because printer is being used. 401 Authentication Required As authentication is carried out by lighttpd. Repair is present. 400 Bad Request { "message": "Setting values... keyname and Server Error value in the prescribed manner as "message": "Failed to insufficient memory. Communication was successful. Refer to "Reset the Printer" on page 19. 500 Internal Server Error { "message": "Failed: No enough memory" } Failed due to update the settings" described ...
... Entity Too For the maximum size of keyname and 200 OK value by the following way. { "Setting" : Updating was not possible because printer is being used. 401 Authentication Required As authentication is carried out by lighttpd. Repair is present. 400 Bad Request { "message": "Setting values... keyname and Server Error value in the prescribed manner as "message": "Failed to insufficient memory. Communication was successful. Refer to "Reset the Printer" on page 19. 500 Internal Server Error { "message": "Failed: No enough memory" } Failed due to update the settings" described ...
Users Manual - WebConfig API
Page 19
Passwords To ensure security, all passwords are displayed as a password. Operation specifications Printer Response Time Response is not used as follows: When registered: (Registered) When not registered: (Not registered) "Registered" and "Not Registered" cannot be used ...
Passwords To ensure security, all passwords are displayed as a password. Operation specifications Printer Response Time Response is not used as follows: When registered: (Registered) When not registered: (Not registered) "Registered" and "Not Registered" cannot be used ...
Users Manual - WebConfig API
Page 22
...": "5", "Name": "ECCN905633", "Password": "(Not registered)", "Url": "", "UseProxy": "OFF", "UseServerAuthentication": "OFF", "UseUrlEncode": "ON" } }, "message": "Success : Please confirm by get again and You need to reset the printer to apply settings." } 22
...": "5", "Name": "ECCN905633", "Password": "(Not registered)", "Url": "", "UseProxy": "OFF", "UseServerAuthentication": "OFF", "UseUrlEncode": "ON" } }, "message": "Success : Please confirm by get again and You need to reset the printer to apply settings." } 22
Users Manual - WebConfig API
Page 23
... use items included in the GET response body for creation. *: Not supported by TM-T88VI. When using GET, this is included in the request body. Chapter 3 Reference Reference This chapter explains items that can be acquired from the printer, as well as items and values that can be set the value of this...
... use items included in the GET response body for creation. *: Not supported by TM-T88VI. When using GET, this is included in the request body. Chapter 3 Reference Reference This chapter explains items that can be acquired from the printer, as well as items and values that can be set the value of this...
Users Manual - WebConfig API
Page 24
Characters that can be any duplicate string for another DeviceID. "TM-T88VI" Network printer The ID for identifying the printer. "US", "JP", "DE", "FR", "IR", "ES", "GB" 24 String with a length of 1 to 30 characters. The ID for identifying the printer. Device ID specified for another DeviceID. String with a length of 1 to 30 characters. There must...
Characters that can be any duplicate string for another DeviceID. "TM-T88VI" Network printer The ID for identifying the printer. "US", "JP", "DE", "FR", "IR", "ES", "GB" 24 String with a length of 1 to 30 characters. The ID for identifying the printer. Device ID specified for another DeviceID. String with a length of 1 to 30 characters. There must...
Users Manual - WebConfig API
Page 26
...cable. String with 1 to 30 or less characters. "7", "8" 26 Specify the USB serial conversion cable product name. 0 or more to the printer's serial connector. Specify the USB serial conversion cable USB product ID. Empty string if the device is connected to 30 or less characters. Specify ...the USB serial conversion cable vendor name. 0 or more to the printer's serial connector. Specify the cable PID within the range from XXX to YYY in the case of a USB serial conversion cable. "2400", "...
...cable. String with 1 to 30 or less characters. "7", "8" 26 Specify the USB serial conversion cable product name. 0 or more to the printer's serial connector. Specify the USB serial conversion cable USB product ID. Empty string if the device is connected to 30 or less characters. Specify ...the USB serial conversion cable vendor name. 0 or more to the printer's serial connector. Specify the cable PID within the range from XXX to YYY in the case of a USB serial conversion cable. "2400", "...
Users Manual - WebConfig API
Page 27
"0" to "255" DefaultDeviceControlScriptList * This is the device control script embedded in the printer. Keyboard_Generic.js 3 DeviceType Specify the device type. FileName Specify the file name. DeviceControlScript1 Specify the device control script. type_keyboard DeviceGroup Specify the device group. Keyboard_MID_QM128A_RAA....
"0" to "255" DefaultDeviceControlScriptList * This is the device control script embedded in the printer. Keyboard_Generic.js 3 DeviceType Specify the device type. FileName Specify the file name. DeviceControlScript1 Specify the device control script. type_keyboard DeviceGroup Specify the device group. Keyboard_MID_QM128A_RAA....
Users Manual - WebConfig API
Page 29
...server port number. Characters that can be used are single-byte alphanumeric characters (0 to 9, a to z, A to Z), "_", "." The printer serial number is used are "ON". UseProxy of ServerDirectPrint UseProxy of StatusNotification UseProxy of WebContentsUpdater Specify the proxy ..."65535" Specify the proxy server authentication ID. 3 Empty string or string with 1 to 30 characters. It is left empty if the printer serial number is enabled/disabled. Empty string or string with 1 to specify "ON" for this setting if the following cannot be used are...
...server port number. Characters that can be used are single-byte alphanumeric characters (0 to 9, a to z, A to Z), "_", "." The printer serial number is used are "ON". UseProxy of ServerDirectPrint UseProxy of StatusNotification UseProxy of WebContentsUpdater Specify the proxy ..."65535" Specify the proxy server authentication ID. 3 Empty string or string with 1 to 30 characters. It is left empty if the printer serial number is enabled/disabled. Empty string or string with 1 to specify "ON" for this setting if the following cannot be used are...
Users Manual - WebConfig API
Page 31
Characters that can be used are single-byte alphanumeric characters (0 to 9, a to z, A to specify "ProxyInfo". The printer serial number is used are single-byte alphanumeric characters (0 to 9, a to z, A to Z), "_", "." It is left empty if the printer serial number is enabled/disabled. Characters that can be used are single-byte alphanumeric characters (0 to 9, a to...
Characters that can be used are single-byte alphanumeric characters (0 to 9, a to z, A to specify "ProxyInfo". The printer serial number is used are single-byte alphanumeric characters (0 to 9, a to z, A to Z), "_", "." It is left empty if the printer serial number is enabled/disabled. Characters that can be used are single-byte alphanumeric characters (0 to 9, a to...
