Qeedji SAP10e, User Manual

Page: 56 / 58

56
6.3 Appendix: Web services
These are the supported Web services for the
regular
application to command and control the SAP10e:
Examples by using Curl tool
The value 192.168.1.50 is an IP address example of a SAP10e device, and
admin
/
admin
, the login credentials to access to the Web services of the
SAP10e device:
curl command example to get the device firmware version:
curl --user "admin:admin" -X GET "http://192.168.1.50/api/v1/software/version"
curl command example to get the list of the paired devices:
curl --user "admin:admin" -X GET "http://192.168.1.50/api/v1/wpan1/slate/devices-info"
Web site
When the Web services are executed from Web site, it may be required to configure the device so that the Web services can be supported properly:
the CORS header should be activated,
the origin or your Web site should be defined.
For further information, refer to the chapter § Maintenance > Preferences .
GET POST PUT DELETE
api/v1/sys/power yes <state>=rebooting "" Reboot the device 1.11.10
api/v1/software/version yes i.e.: {"value":"1.10.11"}
Get the device delivery
software version
1.11.10
api/v1/software/label yes {"value":"bm0032_generic_server"}
Get the device delivery
software label
1.11.10
api/v1/sys/sn yes PSN Short representation: i.e.: {"value":"01390-00004"}Get the device SN 1.11.10
api/v1/sys/model-name yes {"value":"SAP10e"}
Get the device model
name
1.11.10
api/v1/sys/manufacturer yes {"value":"Qeedji"} Get the manufacturer 1.11.10
api/v1/sys/manufacturer-url yes {"value":"www.qeedji.tech"}
Get Web Site of
manufacturer
1.11.10
api/v1/sys/uuid yes
Uuid string value: <uuid> = <psn>-<48x0>-<mac-48>
i.e.:
{"value":"08400004-0000-0000-0000-001ce6024cad"}
Get the device UUID 1.11.10
api/v1/wpan1/mac yes
Bluetooth MAC address value user formatted:
i.e.: {"value":"e6:97:8c:83:b3:8d"}
Get the device Bluetooth
MAC address
1.11.10
api/v1/wpan1/slate/capabilities yes
The key "maxDevices" tells the maximum number of paired
Slates.
{"maxDevices": 10}
Get the max. number of
SLATEs device supported
by the SAP10e devices.
1.11.10
api/v1/wpan1/slate/devices-info yes
The key "devices" is an array of JSON objects
containing keys useful for
this web service.
{"devices": [
{ "index": 1, "hostname": "sap1", "serialNumber":
"PSN01390-00258 CD6",
"manufacturerName": "Qeedji", "modelNumber":
"SLATE106",
"hardwareRevision": "Rev.C", "firmwareRevision":
"1.11.10",
"softwareRevision": "1.11.11",
"batteryLevelPercentage": 35, "rssi": "-
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" }
]}
Retrieve the device
information and the
battery level for each
SLATE connected to the
SAP10e access point.
1.11.10
api/v1/wpan1/slate/pictureframe yes
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"},
{"index":"3", "pictureEtag":"0x358cebf1",
"pictureSyncState":"unsynchronized"},
{"index":"5", "pictureEtag":"0x04f04943",
"pictureSyncState":"undefined"}
]}
with "pictureSyncState" = "synchronized" |
"unsynchronized" |
"undefined"
Get the synchronization
status of each SLATEs
showing whether the
SLATEs content are
properly synchronized
with the PPK picture
available on the SAP10e
access point.
1.11.10
From the
generic_server
application
version
Web services paths
HTTP method
Query string parameters Body Description