Epson TM-m50II Epson POS Printer WebAPI Interface Specification - Page 27

Basic API

Page 27 highlights

4.4. Basic API The Basic APIs enable the Application to provide some features such as configure device settings. 4.4.1. /SET This API is used to configure device settings related to the entire features provided by the Device, for example, network environment, Access Control, certificate for security communication, admin account, etc. The Application MUST call the /SET API to configure device settings using the configuration data formatted by JSON including an Access Token of WebAPI. 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 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 input parameters as below. Query String admin_password Comments If an account of administrators is set to the Device, a password for the account MUST be set. The message body should contain the configuration data by JSON. Message Body Comments Configuration Data JSON data which is created based on the Configuration Data Schema. (JSON) See the Configuration Data Schema section for more information. Table 4-4 Input of /SET 4.4.1.2. Return The /SET API returns JSON including following data. Name result Value type string Value Indicate the API acceptance result. Table 4-5 Return value of /SET Example: { "result":"success" } 4.4.2. /GET This API is used to get device settings related to the entire features provided by the Device. Either admin_password or access_token must be present. 4.4.2.1. Input The /GET API has input parameters as below. Query String admin_password Comments A password of the administrator account if it is set to the Device, Epson POS Printer WebAPI Interface Specification Revision A M00152302 September 8, 2022 Page: 27

  • 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: 27
4.4.
Basic API
The Basic APIs enable the Application to provide some features such as configure device settings.
4.4.1.
/SET
This API is used to configure device settings related to the entire features provided by the Device, for example, network
environment, Access Control, certificate for security communication, admin account, etc.
The Application MUST call the /SET API to configure device settings using the configuration data formatted by JSON including
an Access Token of WebAPI.
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 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 input parameters as below.
Query String
Comments
admin_password
If an account of administrators is set to the Device, a password for the account
MUST be set.
The message body should contain the configuration data by JSON.
Message Body
Comments
Configuration Data
(JSON)
JSON data which is created based on the Configuration Data Schema.
See the Configuration Data Schema section for more information.
Table 4-4 Input of /SET
4.4.1.2.
Return
The /SET API returns JSON including following data.
Name
Value type
Value
result
string
Indicate the API acceptance result.
Table 4-5 Return value of /SET
Example:
4.4.2.
/GET
This API is used to get device settings related to the entire features provided by the Device.
Either admin_password or access_token must be present.
4.4.2.1.
Input
The /GET API has input parameters as below.
Query String
Comments
admin_password
A password of the administrator account if it is set to the Device,
{
"result":"success"
}