HELLA Aglaia APS-180 Api Reference Manual Download Page 44

Page: 44 / 48

44 / 48

The reproduction, distribution and utilization of this document as well as the communication of its contents to others without

express authorization is prohibited. Offenders will be held liable for the payment of damages.

14.04.2020

Version 1.18.0

Appendix

REST

7 Appendix

7.1

HTTP error codes

Some errors occur from the lower http layer. Most of these error messages are not APS internal - these are answers of the

requested server:

Error Code

Description

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

Summary of Contents for APS-180

Page 1: ...HELLA Aglaia People Sensing Technologies people sensing com HAGL 120 00082 Version 1 18 0 Reference manual REST APS 90 APS 180 and APS 90 Outdoor PoE Advanced People Sensor Original document...

Page 2: ...ders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 HELLA Aglaia Mobile Vision GmbH Berlin HEL...

Page 3: ...xpressly agreed upon in writing HELLA Aglaia Mobile Vision GmbH is not obligated to notify the owner or user of the devices described in this manual including the respective software of any revisions...

Page 4: ...the ObjectClassification License Wireless tracking for WiFi and Bluetooth with the WirelessServices License and the USB WiFi Bluetooth Adapter 1 16 0 New layout 1 15 1 Chapter 3 Removed hint for token...

Page 5: ...ta security 8 2 3 Versioning 8 2 4 Base path 9 2 5 Licenses 9 3 Authorisation 10 3 1 Token information 10 3 2 Auth 10 3 3 Example for initial token request 11 3 4 Using tokens 11 4 Update 13 5 Sensor...

Page 6: ...thers without express authorization is prohibited Offenders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Ve...

Page 7: ...ata from a device in an in store network we established a push interface using SOAP XML Lately we ve received requests from customers that already have servers or gateways in the in store network and...

Page 8: ...ned users exist The user manage ment will be reworked in the upcoming firmware versions allowing individual users with distinct access rights user role view Access rights Request data all GET operatio...

Page 9: ...le is only the path the call request itself needs bearer token returned from the authentification https 192 168 100 10 8091 apiv1 sensorData 2 5 Licenses There are some optional licenses for the APS t...

Page 10: ...d for 1 hour 3 1 Token information Part Content Comment HEADER typ JWT alg HS256 Token type JsonWebToken Signature type HMAC SHA256 PAYLOAD iat 1492765233 exp 1492768833 nbf 1492765233 identity 2 Time...

Page 11: ...Host 192 168 100 10 Connection keep alive Content Length 48 Origin http 192 168 100 10 Content Type application json charset UTF 8 Referer http 192 168 100 10 username user role edit password admin Re...

Page 12: ...ed in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Authorisation REST Example for a request using a token GET apiv1 sensorData counts HTTP 1 1 Host 192 168 100 10...

Page 13: ...re 1 10 Method Data Result HTTP Status Comments GET not supported 403 Forbidden POST JSON Container with update information NONE 200 OK on success 400 Bad Request on internal error additional informat...

Page 14: ...t express authorization is prohibited Offenders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0...

Page 15: ...lable data Zone monitoring data and wireless logging data will only be trans ferred if the required license is installed on the device Requests Name sensorData URL https deviceIP restPort apiv1 sensor...

Page 16: ...hts reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Response sensorData counts name MyLine0 data class Adult in 42 out 23 class Child in...

Page 17: ...of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST class Cart level 2 avgDwell 6 maxDwell 8 name MyZone1 data class Adult level 3 avgDwell 7 maxDwell 11 class Child level 0 a...

Page 18: ...ensor data REST maxDwell 0 max_fill_level 0 meanDwell 0 class Child count 0 maxDwell 0 max_fill_level 0 meanDwell 0 wirelessLogging timeStamp 2020 04 01T12 04 38 025271 01 00 stations MAC D8 E0 E1 33...

Page 19: ...s Availability APS RS firmware 1 10 Method Data Result HTTP Status Comments GET NONE JSON container with count results 200 OK on success 400 Bad Request on internal error additional information in JSO...

Page 20: ...ges All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Response counts name MyLine0 data class Adult in 42 out 23 class Child in...

Page 21: ...e Availability APS RS firmware 1 10 Method Data Result HTTP Status Comments GET NONE JSON container with count results 200 OK on success 400 Bad Request on internal error additional information in JSO...

Page 22: ...ess authorization is prohibited Offenders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Senso...

Page 23: ...ll zones Request the fill level of all zones Request Name fillLevel URL https deviceIP restPort apiv1 sensorData fillLevel Availability APS RS firmware 1 10 License Zone Monitoring license required Me...

Page 24: ...payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Response fillLevel name MyZone0 data class Adult level 2 a...

Page 25: ...of a specific zones Request Name fillLevel MyZone1 URL https deviceIP restPort apiv1 sensorData fillLevel zoneName Availability APS RS firmware 1 10 License Zone Monitoring license required URL Method...

Page 26: ...s prohibited Offenders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Respons...

Page 27: ...ttps deviceIP restPort apiv1 sensorData zoneStatistics Availability APS RS firmware 1 14 License Zone Monitoring license required Publish interval Zone statistics are calculated over an interval of 1...

Page 28: ...of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Response zoneStatistics name MyZone0 data class Adult count 8 max_fill_level 2 maxDwell 22 meanDwell 16 class...

Page 29: ...ttps deviceIP restPort apiv1 sensorData zoneStatistics zone Name Availability APS RS firmware 1 14 License Zone Monitoring license required Publish interval Zone statistics are calculated over an inte...

Page 30: ...eld liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Sensor data REST Response zoneStatistics name MyZone1 da...

Page 31: ...ttps deviceIP restPort apiv1 sensorData zoneObjectList Availability APS RS firmware 1 15 1 License Zone Monitoring license required Publish interval Zone object list are assembled over an interval of...

Page 32: ...e zoneObjectList timeStamp 2020 04 01T08 10 00 01 00 zones name MyZone0 objects id 2 class Adult dwell 15 exitTime 2020 04 20T12 04 36 025271 01 00 height 176 entry x 103 y 10 exit x 658 y 328 id 1 cl...

Page 33: ...eviceIP restPort apiv1 sensorData zoneObjectList zone Name Availability APS RS firmware 1 15 1 License Zone Monitoring license required Publish interval Zone object list are assembled over an interval...

Page 34: ...el or design 14 04 2020 Version 1 18 0 Sensor data REST Response zoneObjectList timeStamp 2020 04 20T12 04 38 025271 01 00 zones name MyZone0 objects id 2 class Adult dwell 15 exitTime 2020 04 20T12 0...

Page 35: ...me wirelessLogging URL https deviceIP restPort apiv1 sensorData wirelessLogging Availability APS RS firmware 1 10 License Wireless Services license and Wireless USB adapter required Publish interval T...

Page 36: ...Response wirelessLogging timeStamp 2020 04 03T13 32 13 00 00 stations MAC A1 B2 C3 E4 F5 11 Type BLUETOOTH Signal 76 Time 2020 04 29T11 30 06 075467 00 00 MAC FF FF CC 77 BB 66 Type BLUETOOTH Signal...

Page 37: ...Use telnet or ssh to navigate inside the sensor and execute the script ssh To use ssh at a Windows PC use tools like e g PuTTY http www chiark greenend org uk sgtatham putty At first connecting time...

Page 38: ...WORD r ROUTE X CMD v script for testing REST API routes optional arguments h help show this help message and exit i IP ip address p PORT port U USER username P PASSWORD password r ROUTE REST route X C...

Page 39: ...REST 1 2 1 2 The standard setting of Insomnia is to check SSL certificates The APS uses a self generated certificate which cannot be validated First disable the verification of SSL certificates Go to...

Page 40: ...in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Examples REST 3 4 5 1 2 Add user name and password in the JSON Fig 3 1 1 2 3 4 Fig 3 Receive access token Use the...

Page 41: ...grant of patent utility model or design 14 04 2020 Version 1 18 0 Examples REST 3 4 5 6 Fig 5 Define authentication method Go to the area AUTH Fig 5 1 and select the method Bearer Token Fig 5 2 Copy t...

Page 42: ...e payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Examples REST 1 2 Send https my sensor IP 8091 apiv1 sensorData Fig 7 1 F...

Page 43: ...ibited Offenders will be held liable for the payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Examples REST 3 Send https my...

Page 44: ...payment of damages All rights reserved in the event of the grant of patent utility model or design 14 04 2020 Version 1 18 0 Appendix REST 7 Appendix 7 1 HTTP error codes Some errors occur from the lo...

Page 45: ...dia container format from Microsoft that allows syn chronous audio with video playback Binary to text encoding by translating it into a radix 64 representation Bluetooth Low Energy One of the used wir...

Page 46: ...er Simple Object Access Protocol Network protocol for exchanging data between systems and implementing remote proce dure calls Uniform Resource Locator Reference to a web resource including protocol s...

Page 47: ...r design 14 04 2020 Version 1 18 0 Index REST 9 Index A Access rights 8 Authorisation 10 B Base Path 9 Bearer token 11 Bluetooth 35 C Copyright information 3 D Data security 8 E Error Codes HTTP 44 Ex...

Page 48: ...n GmbH A member of the HELLA group Ullsteinstra e 140 12109 Berlin Germany phone 49 0 30 2000 429 625 fax 49 0 30 2000 429 149 mail info people sensing com www people sensing com 246 247 248 249 250 2...

Search results

Summary of Contents for APS-180

Reviews:

Related manuals for APS-180

Brands by name

Popular brands

HELLA Aglaia APS-180, Api Reference Manual

Search results

Summary of Contents for APS-180

Reviews:

Related manuals for APS-180

Brands by name

Popular brands