Epson TM-T88VI-i Users Manual - WebConfig API

Epson TM-T88VI-i Manual

Get Epson TM-T88VI-i PDF manuals and user guides View all Epson TM-T88VI-i manuals
Add to My Manuals
Save this manual to your list of manuals

Epson TM-T88VI-i manual content summary:

  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 1
    TM-T88VI/ TM-T88VI-iHUB WebConfig API User's Manual Overview Describes an overview of WebConfig API. Web API Specification Describes the web API specification. Reference Describes how to refer to and change setting values. M00105900 Rev.A
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 2
    to this product, or (excluding the U.S.) failure to strictly comply with Seiko Epson Corporation's operating and maintenance instructions.  Seiko Epson Corporation shall not be liable against any damages or problems arising from the use of any options or any consumable products other than those
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 3
    For Safety Key to Symbols The symbols in this manual are identified by their level of importance, as defined below. Read the following carefully before handling the product. Provides important information and useful tips. Restriction
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 4
    development engineers with the necessary information to develop applications to set and refer to the WebConfig API for the TM-T88VI and the TM-T88VI-iHUB. Manual Content The manual is made up of the following sections: Chapter 1 Overview Chapter 2 Web API Specification Chapter 3 Reference 4
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 5
    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
  • Epson TM-T88VI-i | 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
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 7
    Chapter 1 Overview Overview Overview of WebConfig API WebConfig API is an API used to configure TM printers via the web. It is mainly used after being incorporated into customer applications. It uses the GET and PUT methods defined in HTTP to retrieve and modify setting
  • Epson TM-T88VI-i | 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
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 9
    Usage Instructions Chapter 1 Overview Acquisition and Configuration of Setting Values This section explains the system sequence and each element needed in order to acquire set values from printers and specify the settings by using the WebConfig API. Acquisition and Configuration of Setting Values
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 10
    data: https:///webconfig/api/v1 from the printer. For example: Acquisition JSON data ... "StatusNotification": { "Active": "OFF", "ID": "", "Interval": "5", "Name": "" "Password": "(
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 11
    for each key set in the printer and the JSON set values acquired from the printer, and check that they have been properly revised. Digest authentication You need Digest authentication to communicate with the printer. The default ID and Password are ID: epson, Pass: epson and are the same as the
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 12
    Restrictions Manual uploading of web content (.zip files) and certificate files are not possible. In order to upload these, it is necessary to use an uploading program, or upload using the TM-T88VI Utility. 12
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 13
    settings: https:///webconfig/api/v1/reset.cgi HTTP Method  GET: Acquires setting values  PUT: Updates setting values Other methods such as OPTIONS and HEAD are also supported. 2 Response The
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 14
    default- password is incorrect). It is not specified when digest authentica- ● ● ● tion is completed normally. Digest realm="", nonce="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" Response Body HTTP Method GET PUT Description The setting values are returned from the printer
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 15
    -Type: application/json; 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 "GET
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 16
    keyname1>, ... 200 OK 503 Service Unavailable 500 Internal Server Error { "Cannot communi- cate with the printer : The other host interface may hold the communication", } memory. Repair is necessary if the problem occurs even after restarting the printer. 400 Bad Request { "Setting
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 17
    Chapter 2 Web API Specification PUT method PUT method: Updates setting values. PUT Parameter is necessary if the problem occurs even after restarting the printer. 503 Service Unavailable { "message": "Cannot communi- cate with the printer : The other host interface may hold the communication"
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 18
    PUT Parameter Response (status) Response (body) Description 400 Bad Request { "message": "Special characters must be escaped" } Invalid JSON escape. When Using a Prohibited Method "405 Method Not Allowed" or "403 Forbidden" is returned as the response (status). 18
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 19
    Characters Chapter 2 Web API Specification Character Code UTF-8 Escape Sequence According to be used as a password. When registering/changing a password, please replace the (Registered) or (Not registered) string with the desired password. Operation specifications Printer Response Time Response
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 20
    or IP address> Authorization: Digest username="epson", mode=block" X-Frame-Options: deny Content-Security-Policy: default-src 'none' Connection: close Transfer-Encoding: chunked Date: "ID": "", "Interval": "5", "Name": "ECCN905633", "Password": "(Not registered)", "Url": "", "UseProxy": "OFF", "
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 21
    Chapter 2 Web API Specification PUT request example (key specification)  Request Request Header PUT /webconfig/api/v1/webconfig.cgi HTTP/1.1 Authorization: Digest username="epson", realm="ByPassword", nonce="", uri="/webconfig/api/v1/webconfig.cgi", response="
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 22
    Frame-Options: deny Content-Security-Policy: default-src 'none' Connection: close Transfer- Password": "(Not registered)", "Url": "", "UseProxy": "OFF", "UseServerAuthentication": "OFF", "UseUrlEncode": "ON" } }, "message": "Success : Please confirm by get again and You need to reset the printer
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 23
    This chapter explains items that can be acquired from the printer, as well as items and values that can be set to be set, and use items included in the GET response body for creation. *: Not supported by TM-T88VI. Key 1 Key 2 Key 3 Key 4 Description Value ePOS-Print ePOS-Print setting Active
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 24
    The IP address for identifying the printer. String in IPv4 address format. %A: 1 to 223 %B: 0 to 255 %C: 0 to 255 %D: 0 to 254 There must not be any duplicate IPAddress for another device. Specify the printer model name. Model name string (For support printers, refer to the Technical Reference Guide
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 25
    key input devices.  String with 1 to 255 ASCII characters.  "Keyboard_Generic.js" (When controlling as a keyboard)  "Scanner_Generic.js" (When controlling as a barcode scanner) InterfaceNumber Specify the USB interface number for identifying the key input device. "0" to "255" 25
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 26
    . Specify the cable VID within the range from XXX to YYY in the case of a USB serial conversion cable. Specify the USB serial conversion cable USB product ID. Empty string if the device is connected to the printer's serial connector. Specify the cable PID within the range from XXX to YYY in the case
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 27
    Specify the flow control. "None", "Hardware", "XOnXOff" InterfaceNumber Specify the interface number. "0" to "255" DefaultDeviceControlScriptList * This is the device control script embedded in the printer. It can be referenced but not specified. DeviceControlScript1 Specify the device
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 28
    Key 1 Key 2 Key 3 DeviceControlScript4 FileName Key 4 DeviceType DeviceGroup DeviceControlScript5 FileName DeviceType DeviceGroup DeviceControlScript6 FileName DeviceType DeviceGroup DeviceControlScript7 to DeviceControlScript10 FileName DeviceType DeviceGroup Description Value
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 29
    A to Z), "_", "." and "-". Specify the proxy server authentication password. Empty string or string with 1 to 30 characters. Characters that can characters (0 to 9, a to z, A to Z), "_", "." and "-". The printer serial number is used for "Name" when the initial value or an empty string is
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 30
    Key 3 Url1 to Url3 Interval1 to Interval3 UseServerAuthentication UseProxy UseUrlEncode CutReserveTimeout Key 4 Description Value Specify the Digest authentication Password. Empty string or string with 1 to 30 characters. Characters that can be used are single-byte alphanumeric characters
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 31
    for "Name" when the initial value or an empty string is specified. It is left empty if the printer serial number is not set. ID Specify the Digest authentication ID. Password Empty string or string with 1 to 30 characters. Characters that can be used are single-byte alphanumeric characters
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 32
    Key 1 Key 2 Key 3 PrintForwarding PrintForwarding PrintMessage AlertMessage MessageAttrs MessagePosition RetryCount RetryInterval Key 4 Description Value Print forwarding settings. Specify whether the print forwarding and spooling functions are enabled/disabled. "OFF", "ON w/cut", "ON w/o
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 33
    ID of the display (local_display). This must not be a duplicate of another primary device ID. Secondary Specify the device ID for the secondary candidate printer in the list. Empty string or string with 1 to 30 characters. Characters that can be used are single-byte alphanumeric characters (0 to
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 34
    Value Designates the password used for Digest . "Registered", "Not Registered" Specify the URL of Web contents that are automatically updated. The communication destination server URL ID of device specified in the Printer, Key input device or Serial communication device, or "local_display". 34
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 35
    It is left empty if the printer serial number is not set. ID Specify the Digest authentication ID. Password Empty string or string with 1 specified. "Registered", "Not Registered" Url Specify the URL for web content to be automatically updated. The communication destination server URL string.
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 36
    Key 1 Key 2 Schedule Key 3 Key 4 TimeInterval Week Day Hour Minute LastResult TimeStamp UpdateDate UpdateStatus Description Value Depending on the content of this setting, it is necessary to specify the following:  Hourly: TimeInterval  Daily: Hour, Minute  Weekly: Week, Hour, Minute
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 37
    time difference) if an invalid value is specified.) DocumentPath Specify the Web document path. Specify the WebConfigPath and UserWebAppPath by using 3 the the WebConfig path. "\/", "\/PrinterConfigurationPage" UserWebAppPath Specify the user web application path. "\/", "\/webapp" 37
  • Epson TM-T88VI-i | Users Manual - WebConfig API - Page 38
    38
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
TM-T88VI/ TM-T88VI-iHUB
WebConfig API User's Manual
M00105900
Rev.A
Overview
Web API Specification
Reference
Describes an overview of WebConfig API.
Describes the web API specification.
Describes how to refer to and change setting values.