Skip to main content

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​

GEThttps://my.ence.do/api/system/checkin

Get a device check-in challenge data.

Response status code​

{
"check": "eyJlY2RoIjoieDI1NTE5IiwidHlwIjoiSldUIiwiYWxnIjoiSFMyNTYifQ.eyJqdGkiOiJrSUEzWXJDQWJpMXZDVTFoOHlwbjJLdHMxUVNET1FVS05zYVVJZ1dvU3IwPSIsImlzcyI6IjBrUm1DbGlVUXZSd2Z4aTdUMWVrMkd0YlNFUnpNRlJHTGV5TzFyMXRFWG89IiwicWlkIjoiZTZQQXZDWnJtTWMwZlVUMEt6bUw3STNUSXo2UUZBNEpCallzbEU5ZisvQT0iLCJhdWQiOiIvTGJ4bzVNZ1U2Wk90VnN4eEc1akNRNSs0ZXd4b2ExclY4ZXFNSUZGblRBPSIsImZ3cyI6Ilora0FhamdWVmRTTVFqTkl2SzVGR3owKzlyZi9KdXRWQ2xOWTZTN0dCZVE3NjVOTVlFVC9YZ2RBNjFjbU1rMTV3YXcwOG9OTHVXbVV5Z0hLM3hXRkNBPT0iLCJibHMiOiI4TXdvd3NLa3hnRVdubDJrMHQvZU92c2pUYlI3MHBvWUMyY3p5UEl3S24vaFZMNjhXRjNRYVF3WjFieFZjWXY3ZzhXRXd5ekoyUFZuVEZBbFlRN2hCZz09IiwidWlzIjoiNkdoMmNDcVNKMEdVTFFLRTFEaWJvWTFPc0M4ck01KzF4UFpjbENuaHRybz0iLCJjc24iOiJLZnNhS0t2Tmw0THZQaWdsMEdtR0JnPT0ifQ.dn2cwBODoUKkGKrr92IW13NgVg7j-h6VGO-tnADqins"
}

Response data for successful operation​

NameTypeDescription
checkStringCheck-In challenge data generated by HEM

Phase 2 - Response​

Checkin response​

POSThttps://my.ence.do/api/system/checkin

Process server response for the device check challenge.

Headers​

NameTypeDescription
Content-Type*Stringapplication/json

Request Body​

NameTypeDescription
checked*StringCheckin data sent by the backend server

Response status code​

{
"status": "OK"
}

Response data for successful operation​

NameTypeDescription
newcrtStringStatus of the TLS certificate update.
newfwsStringInfo about the new firmware version.
newuisStringInfo about the new Manager version (on Encedo PPA only).
statusStringCheckin status - general information.

Log entries​

EventResultSource
LOG_TYPE_RTC_SETLOG_RESULT_OK200 (if RTC is been updated)
LOG_TYPE_SHUTDOWNLOG_RESULT_OK200 (if the device shutdown or locked)