Checkin
Those endpoints perform check-in procedures, a'ka firmware verification and setup of RTC based on trusted data.
info
These two endpoints are wide open and do not need any authorisation data.
Phase 1 - Challenge
Checkin challange
GET
https://my.ence.do/api/system/checkinGet a device check-in challenge data.
Response status code
- 200: Successful operation
- 412: Protocol error - CORS validation failed
- 500: Internal server error
{
"check": "eyJlY2RoIjoieDI1NTE5IiwidHlwIjoiSldUIiwiYWxnIjoiSFMyNTYifQ.eyJqdGkiOiJrSUEzWXJDQWJpMXZDVTFoOHlwbjJLdHMxUVNET1FVS05zYVVJZ1dvU3IwPSIsImlzcyI6IjBrUm1DbGlVUXZSd2Z4aTdUMWVrMkd0YlNFUnpNRlJHTGV5TzFyMXRFWG89IiwicWlkIjoiZTZQQXZDWnJtTWMwZlVUMEt6bUw3STNUSXo2UUZBNEpCallzbEU5ZisvQT0iLCJhdWQiOiIvTGJ4bzVNZ1U2Wk90VnN4eEc1akNRNSs0ZXd4b2ExclY4ZXFNSUZGblRBPSIsImZ3cyI6Ilora0FhamdWVmRTTVFqTkl2SzVGR3owKzlyZi9KdXRWQ2xOWTZTN0dCZVE3NjVOTVlFVC9YZ2RBNjFjbU1rMTV3YXcwOG9OTHVXbVV5Z0hLM3hXRkNBPT0iLCJibHMiOiI4TXdvd3NLa3hnRVdubDJrMHQvZU92c2pUYlI3MHBvWUMyY3p5UEl3S24vaFZMNjhXRjNRYVF3WjFieFZjWXY3ZzhXRXd5ekoyUFZuVEZBbFlRN2hCZz09IiwidWlzIjoiNkdoMmNDcVNKMEdVTFFLRTFEaWJvWTFPc0M4ck01KzF4UFpjbENuaHRybz0iLCJjc24iOiJLZnNhS0t2Tmw0THZQaWdsMEdtR0JnPT0ifQ.dn2cwBODoUKkGKrr92IW13NgVg7j-h6VGO-tnADqins"
}
No response body.
No response body.
Response data for successful operation
| Name | Type | Description |
|---|---|---|
check | String | Check-In challenge data generated by HEM |
Phase 2 - Response
Checkin response
POST
https://my.ence.do/api/system/checkinProcess server response for the device check challenge.
Headers
| Name | Type | Description |
|---|---|---|
| Content-Type* | String | application/json |
Request Body
| Name | Type | Description |
|---|---|---|
checked* | String | Checkin data sent by the backend server |
Response status code
- 200: Successful operation
- 400: Incorrect argument(s)
- 401: Provided data validation failed
- 411: Protocol error - Content-Length required
- 412: Protocol error - CORS validation failed
- 413: Protocol error - request body too big
- 500: Internal server error
{
"status": "OK"
}
No response body.
No response body.
No response body.
No response body.
No response body.
No response body.
Response data for successful operation
| Name | Type | Description |
|---|---|---|
newcrt | String | Status of the TLS certificate update. |
newfws | String | Info about the new firmware version. |
newuis | String | Info about the new Manager version (on Encedo PPA only). |
status | String | Checkin status - general information. |
Log entries
| Event | Result | Source |
|---|---|---|
| LOG_TYPE_RTC_SET | LOG_RESULT_OK | 200 (if RTC is been updated) |
| LOG_TYPE_SHUTDOWN | LOG_RESULT_OK | 200 (if the device shutdown or locked) |