Appendix: Web Services - Qeedji SAP10e User Manual

6 .3 Appendix : W eb services
These are the supported Web services for the
Webservice path
api/v1/sys/power
api/v1/lan1
api/v1/disk1/1
api/v1/software/version
api/v1/software/label
api/v1/sys/sn
api/v1/sys/model-name
api/v1/sys/manufacturer
api/v1/sys/manufacturer-
url
api/v1/sys/uuid
api/v1/wpan1/mac
api/v1/sys/datetime
api/v1/wpan1/slate/capabi
lities
api/v1/wpan1/slate/device
s-info
api/v1/wpan1/slate/pictur
eframe
Ex amples by using Curl tool
192.168.1.50 is an IP address example of a SAP10e device, and
curl command example to get the device firmware version:
curl --user "admin:admin" -X
curl command example to get the list of the paired devices:
curl --user "admin:admin" -X
application to command and control the SAP10e:
regular
HTTP method
Query string
parameters
GET POST PUT DELETE
<state>=rebooti
yes ""
ng
{"mac":"00:1c:e6:02:50:e1",
"ipConfiguration":"DHCP",
"ipv4Address":"192.168.1.113",
yes "ipv4Netmask":"255.255.128.0",
"ipv4Gateway":"192.168.0.1",
"dnsPrimary":"192.168.0.4",
"dnsSecondary":"192.168.0.1"}
yes {"freeSpaceKiB":6392,"totalSpaceKiB":7916}
yes {"value":"1.10.10"}
yes {"value":"bm0032_regular"}
yes {"value":"01390-00004"}
yes {"value":"SAP10e"}
yes {"value":"Qeedji"}
yes {"value":"www.qeedji.tech"}
yes {"value":"08b00004-0000-0000-0000-001ce60250e1"}
yes {"value":"e6:97:8c:83:b3:8d"}
yes {"value":"2020-12-29T08:00:00+01:00"}
The key "maxDevices" tells the maximum number of paired Slates.
yes
{"maxDevices": 10}
The key "devices" is an array of JSON objects containing keys useful for
this web service.
{"devices": [
{ "index": 1, "hostname": "sap1", "serialNumber": "PSN00900-00258 CD6",
"manufacturerName": "Qeedji", "modelNumber": "SLATE106",
"hardwareRevision": "Rev.C", "firmwareRevision": "1.11.10",
"softwareRevision": "1.11.11", "batteryLevelPercentage": 35, "rssi": "-
yes
65"},
{"index": 5, "hostname": "sap5", "serialNumber": "PSN00900-00259 CD6",
"manufacturerName": "Qeedji", "modelNumber": "SLATE106",
"hardwareRevision": "Rev.C", "firmwareRevision": "1.11.10",
"softwareRevision": "1.11.11", "batteryLevelPercentage": 45, "rssi": "-
65" }
]}
The key "devices" is an array of JSON objects containing keys useful for
this web service.
{"devices": [
{"index":"1", "pictureEtag":"0x219486bf",
"pictureSyncState":"synchronized"},
{"index":"2", "pictureEtag":"0xba42a3f5",
"pictureSyncState":"synchronized"},
yes {"index":"3", "pictureEtag":"0x358cebf1",
"pictureSyncState":"unsynchronized"},
{"index":"5", "pictureEtag":"0x04f04943",
"pictureSyncState":"undefined"}
]}
with "pictureSyncState" = "synchronized" | "unsynchronized" |
"undefined".
G ET "http://192.168.1.50/api/v1/software/version"
G ET "http://192.168.1.50/api/v1/wpan1/slate/devices-info"
Body
/ , its login credentials to access to the Web server of the SAP10e:
admin admin
54
Function
Reboot the device
Get the LAN interface parameters
Get the available free space / total space on the SAP10e
device file system
Get the device delivery software version
Get the device delivery software label
Get the device PSN
Get the device model name
Get the manufacturer
Get Web Site of manufacturer
Get the device UUID
Uuid string value <uuid> = <psn>-<48x0>-<mac-48>
Get the device Bluetooth MAC address
Get the device local date & time
(format: ISO 8601)
Get capabilities of the slate resources.
This is a web service to retrieve BLE service "Device
Information" and the battery level.
This is an applicative web service. It is used to know if
the display of a Slate in synchronized with the picture
on the access point.
From the
SAP10e Regular
version
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10
1.10.10