Epson TM-m50II Epson POS Printer WebAPI Interface Specification
Epson TM-m50II Manual
 |
View all Epson TM-m50II manuals
Add to My Manuals
Save this manual to your list of manuals |
Epson TM-m50II manual content summary:
- Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 1
Epson POS Printer WebAPI Interface Specification (Application Programming Interfaces (APIs) for device control) Revision A TM-m30III TM-m30III-H TM-m50II TM-P20II TM-P80II Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 1 - Epson TM-m50II | 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 TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 3
Change Document List Revision Date Notes Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 3 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 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 ...27 4.4.2. /GET ...27 4.4.2.1. Input ...27 4.4.2.2. Return ...28 Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 5
4-2 Response Message...26 Table 4-3 API Error Response...26 Table 4-4 Input of /SET ...27 Table 4-5 Return value of /SET ...27 Table 4-6 Return value of /GET ...28 Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 5 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 6
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 Browser allows the Application to provide the APIs allow - Epson TM-m50II | 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 Administration settings in Configuration Data Schema section for more information. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 7 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 8
Name AdminSettings ProductSecuritySettings SystemSettings NetworkSettings NetworkSecuritySettings Services Printer Settings Value type object object Date Format 0 : MMDDYYYY 1 : YYYYMMDD 2 : DDMMYYYY Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 9
: Auto 1 : Manual Set using BOOTP 0 : Disable 1 : Enable When "ObtainIPAddr" is Manual, this item is unnecessary 1 : Enable When "ObtainIPAddr" is set to Manual, this item is unnecessary. IP Address(IPv4) DNS Server Setting 0 : Auto 1 : Manual Primary DNS Server IPv4 format When "DNSServerSetting" is - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 10
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 settings 0 : Disable 1 : Enable Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 10 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 11
Disable, this item is unnecessary. Security Key 0, 5, 8 - 63 characters in ASCII When "WiFiEnable" is set to Disable, this item is unnecessary. Table 3-7 Wired LAN Settings Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 11 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 12
-signed Certificate Max 5k bytes in ASCII SelfSignedCertKey string Key of Self-signed Certificate Max 5k bytes in ASCII Table 3-9 SST/TLS Server Certificate Settings Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 12 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 13
required. ID Type for Remote Authentication 1 : Distinguished Name 2 : IP Address 3 : FQDN 4 : Email Address 5 : Arbitrary String When "IkeVersion" is set to 2 (IKEv2), this item is required. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 13 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 14
is required. Authentication Algorithm for IKEv2 1 : SHA-1 2 : SHA-256 3 : SHA-384 4 : SHA-512 5 : MD5 0 : Any When "IkeVersion" is set to 2 (IKEv2), this item is required. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 14 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 15
" is set to IPsec, this item is required. Local Address (Printer) IPv4 or IPv6 Address When "EnableGroupPolicy" is set to Enable, this item is required. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 15 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 16
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 is set to 2 (IKEv2), this item is required. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 16 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 17
. Encryption Algorithm for IKEv1 1 : AES-CBC-128 2 : AES-CBC-192 3 : AES-CBC-256 7 : 3DES 0 : Any When "IkeVersion" is set to 1 (IKEv1), this item is required. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 17 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 18
AH 1 : SHA-1 2 : SHA-256 3 : SHA-384 4 : SHA-512 5 : MD5 0 : Any When "SecurityProtocol" is set to AH, this item is required. Table 3-11 Format of GroupPolicy Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 18 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 19
2 : High Wi-Fi Enable 0 : Disable(Wired LAN Enable) 1 : Enable Same as WiFiEnable of NetworkSettings > WiFi Connection Mode 0 : Infrastructure 1 : Adhoc Same as ConnectionMode of NetworkSettings > WiFi Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 19 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 20
. (Root certificate) Max 5k bytes in ASCII CA Certificate 10 for peer verification. (Root certificate) Max 5k bytes in ASCII Table 3-15 CA Certificate Settings Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 20 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 21
3.1.6. Service Settings "Services" consists of four portions, "Protocol", "MSNetwork, "NetworkScan" and "WiFiDirect". (sec) 0 - 3600 When "AllowRAWPrint" is set to Not Allowed, this item is unnecessary. Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 21 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 22
Name(Read/Write) 0 - 32 characters in ASCII When "EnableSNMPv1" is set to Disable, this item is unnecessary. Allow Access by Epson Tools 0 : Not Allowed 1 : Allowed Enable SNMPv3 0 : Disable 1 : Enable Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 22 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 23
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 Table 3-17 WiFi Direct Settings Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 24
specified pulse 1 (2 pin) occurs 0 : Does not ring 1 : Ring once int When specified pulse 2 (5 pin) occurs 0 : Does not ring 1 : Ring once Table 3-18 Printer Basic Settings Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 24 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 25
", "obtainIPAddr":1, "BOOTPSettings":0, "APIPASettings":0, "IPAddr":"192.168.1.100", "SubnetMask":"255.255.255.0", "DefaultGateway":"192.168.1.1", .......... } *Message Body (JSON) ----- end --- Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 25 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 26
format by JSON in a 200 (OK) response. Name result Value type string Value Indicates the error reason defined by each API. Table 4-3 API Error Response Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 26 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 27
This 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 selected account if it is set to the Device, Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 27 - Epson TM-m50II | Epson POS Printer WebAPI Interface Specification - Page 28
which is created based on the Configuration Data Schema. See the Configuration Data Schema section for more information. Table 4-6 Return value of /GET Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 28
-
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
 |
 |
Epson POS Printer WebAPI Interface Specification Revision A
September 8, 2022
M00152302
Page: 1
Epson POS Printer WebAPI
Interface Specification
(Application Programming Interfaces (APIs) for device control)
Revision A
TM-m30III
TM-m30III-H
TM-m50II
TM-P20II
TM-P80II