Epson Mobilink TM-P80II Epson POS Printer WebAPI Interface Specification
Epson Mobilink TM-P80II Manual
View all Epson Mobilink TM-P80II manuals
Add to My Manuals
Save this manual to your list of manuals |
Epson Mobilink TM-P80II manual content summary:
- Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 1
Epson POS Printer WebAPI Interface Specification (Application Programming Interfaces (APIs) for device control) TM-P20II TM-P80II Revision A Epson POS Printer WebAPI Interface Specification M00152300 Revision A September 8, 2022 Page: 1 - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 2
may only be used for the purposes of research and development of products and services enhancing, enabling, or facilitating existing and future products and services bearing the EPSON trademark, and for providing support to those engaging or intending to engage in such activities. All other uses are - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 3
Change Document List Revision Date Notes Epson POS Printer WebAPI Interface Specification M00152300 Revision A September 8, 2022 Page: 3 - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 4
Administration Settings ...8 3.1.2. Product Security Settings ...8 3.1.3. System Settings ...8 3.1.4. Network Settings ...9 3.1.5. Network Security Settings ...12 3.1.6. Service Settings ...21 3.1.7. Printer Settings ...24 4. APIs ...25 4.1. Request...25 4.2. Response...26 4.3. Error response...26 - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 5
Tables Table 3-1 Configuration Data Schema...8 Table 3-2 Administration Name Settings...8 Table 3-3 Encrypt Password Settings ...8 Table 3-4 Date and Time Settings...9 Table 3-5 Network Basic Settings...11 Table 3-6 Wired LAN Settings...11 Table 3-7 Wired LAN Settings...11 Table 3-8 SST/TLS Basic - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 6
1. Introduction "Epson POS Printer WebAPI " (hereafter called "WebAPI") enables developers to make a Solution such as managed print service, print accounting system, etc. WebAPI is based on the HTTP(S) protocol that provides means for the Application to communicate with Epson Imaging Devices. The - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 7
2. Device Configuration In order to make Services of the Application available, device configuration MUST be completed by the System Integrator using the Application or any other tools in advance. This section helps - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 8
: This schema is used in a request of the /SET API only. Name AdminSettings ProductSecuritySettings SystemSettings NetworkSettings NetworkSecuritySettings Services Printer Settings Value type object object object object object object object Value Administration Settings Product Security Settings - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 9
to Auto, this item is unnecessary. Default Gateway IPv4 format When "ObtainIPAddr" is set to Auto, this item is unnecessary. DNS Server Setting 0 : Auto 1 : Manual Primary DNS Server IPv4 format When "DNSServerSetting" is set to Auto, this item is unnecessary. Secondary DNS Server IPv4 format When - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 10
int string int int string int string string int int int string string string string int DNS Host Name Setting 0 : Manual 1 : Auto DNS Domain Name Setting 0 : Manual 1 : Auto DNS Domain Name 2 - 249 characters in ASCII When "DNSDomainSetting" is set to Auto, this item is unnecessary. Register the - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 11
WirelessBand IPAddressPrint int Wireless Band Setting 0 : Auto 1 : 2.4GHz 2 : 5Ghz int IP Address Print Setting 0 : Disable 1 : Enable Table 3-5 Network Basic Settings "WiredLAN" settings can be set as below. Name Value type LinkSpeed int IEEE8023AZ int Value Link Speed & Duplex 0 - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 12
3.1.5. Network Security Settings "NetworkSecuritySettings" consists of four portions, settings "SSLTLS", "IPsecIPFiltering", "IEEE8021X" and "CACertificate". "SSLTLS" consist of two portions, settings "Basic" and "ServerCertificate". "Basic" settings can be set as below. Name Value type Value - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 13
"IPsecIPFiltering" consist of two portions, settings "Basic" and "ClientCertificate". "Basic" settings can be set as below. Name IPsecFiltering AccessControl IkeVersion AuthMethod PreSharedKey LocalIdType LocalId RemoteAuthMethod RemoteIdType Value type int int int int string int string int int - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 14
RemoteId RemotePreSharedKey Encapsulation RemoteGateway SecurityProtocol IKEv1EncAlgo IKEv2EncAlgo IKEv1AuthAlgo IKEv2AuthAlgo string string int string int int int int int The string of the ID for Remote Authentication. The allowed value depends on the value of LocalIdType. 1 (Distinguished Name) - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 15
IKEv1KeyExcAlgo IKEv2KeyExcAlgo ESPEncAlgo ESPAuthAlgo AHAuthAlgo GroupPolicy Name EnableGroupPolicy AccessControl IkeVersion LocalAddr int int int int int array Key Exchange Algorithm for IKEv1 X : DH Group X (X=1, 2, 5, 14 - 26) 0 : Any When "IkeVersion" is set to 1 (IKEv1), this item is - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 16
Address When "EnableGroupPolicy" is set to Enable, this item is required. Method of Choosing Port 0 : Service Name 1 : Port Number When "EnableGroupPolicy" is set to Enable, this item is required. Service Name String of IPsec target function is input in array. Max 10 ["Any", "ENPC", "SNMP", "LPR - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 17
LocalId RemoteAuthMethod RemoteIdType RemoteId RemotePreSharedKey Encapsulation RemoteGateway SecurityProtocol IKEv1EncAlgo string int int string string int string int int The string of the ID for Local Authentication. The allowed value depends on the value of LocalIdType. 1 (Distinguished Name) : - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 18
IKEv2EncAlgo IKEv1AuthAlgo IKEv2AuthAlgo IKEv1KeyExcAlgo IKEv2KeyExcAlgo ESPEncAlgo ESPAuthAlgo AHAuthAlgo int Encryption Algorithm for IKEv2 1 : AES-CBC-128 2 : AES-CBC-192 3 : AES-CBC-256 4 : AES-GCM-128 5 : AES-GCM-192 6 : AES-GCM-256 7 : 3DES 0 : Any When "IkeVersion" is set to 2 ( - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 19
"ClientCertificate" settings can be set as below. Name Value type Value ClientCert string Client Certificate Max 5k bytes in ASCII ClientCertKey string Key of Client Certificate Max 5k bytes in ASCII CSR string CSR Max 5k bytes in ASCII CSRKey string Key of CSR Max 5k bytes in - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 20
SSID SecuritySetting string int SSID 1 - 32 characters in ASCII Same as SSID of NetworkSettings > WiFi Security Level 0 : None 1 : WEP64 2 : WEP128 3 : TKIP 4 : AES 5 : WPA None 6 : WEP Unknown 7 : WPA2-Enterprise 9 : Unknown Same as SecruitySetting of NetworkSettings > WiFi Table 3-13 IEEE802.1X - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 21
3.1.6. Service Settings "Services" consists of four portions, "Protocol", "MSNetwork, "NetworkScan" and "WiFiDirect". "Protocol" settings can be set as below. Name UseBonjour BonService BonPProtocol WideAreaBonjour EnableiBeaconTransmission EnableUPnP EnableSLP EnableWSD - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 22
AllowRAWCustomPrint int RAWCustomPortNumber int RAWCustomPrintTimeout int EnableIPP int AllowNonSecure int IPPTimeout int PINCodeRequired EnableFTPServer int FTPTimeout int EnableSNMPv1 int EnableSNMPv1Only int EnableSNMPv2cOnly int AccessAuthority int ReadOnlyCommunity - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 23
on the Panel 0 : Disable (Locked) 1 : Enable (Unlocked) Enable or Disable Wi-Fi Direct 0 : Disable 1 : Enable Obtain Method of IP Address 0 : Auto 1 : Manual IP Address(IPv4) IPv4 format(ex. "127.0.0.1") When "ObtainIPAddr" is Auto, this item is unnecessary. Password 8 - 22 characters in ASCII. SSID - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 24
3.1.7. Printer Settings "PrinterSettings" consists of the "PrinterBasic". "PrinterBasic" settings can be set as below. Name Value type Value PaperReduction PrintSpeed PrintDensity CommandExecution PowerSaveFunc Buzzer ErrorOccur AutoPaperCut PaperEnd BatteryLevel SpecifiedPulse1 SpecifiedPulse2 - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 25
4. APIs This section describes the WebAPIs that are exposed to the Application in order for them to operate Devices. The APIs enable the Application to take advantage of the device features such as configure device settings. 4.1. Request All of the APIs use the Request-Line on the HTTP request - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 26
4.2. Response All of the APIs use the Status-Line on the HTTP response message as below. Elements HTTP-Version Status-Code and Reason-Phrase Response Header fields Allowed value "HTTP/1.1" "200" OK "400" Bad Request "404" Not Found "500" Internal Server Error Comply with RFC 2616. If Status-Code - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 27
is an HTTP POST request. Note: The Application can set all fields supported by the Device in Configuration Data Schema using this API regardless of the Platform Version. If the Application sets fields that the Device does not support, the Device ignores those fields. 4.4.1.1. Input The /SET API has - Epson Mobilink TM-P80II | Epson POS Printer WebAPI Interface Specification - Page 28
4.4.2.2. Return The /GET API returns JSON including the following data. Name result Configuration Data (JSON) Value Indicate the API acceptance result. JSON data which is created based on the Configuration Data Schema. See the Configuration Data Schema section for more information. Table 4-6
Epson POS Printer WebAPI Interface Specification
September 8, 2022
M00152300
Revision A
Page:
1
Epson POS Printer WebAPI
Interface Specification
(Application Programming Interfaces (APIs) for device control)
TM-P20II
TM-P80II
Revision A