The method systemSetConnectKey() is called by the server hub to set communication parameters for the connected Remote Client. If the remote cannot accept any of the values in the key, this call should return an error and the remote should disable communications from the server.
| Function |
systemSetConnectKey |
| Purpose |
Sets the connection parameters from the connection key. |
| Parameters |
None |
| URL Format |
/system/setConnectString/:connectKey |
| HTTP Method |
GET - Incoming |
| HTTP Parameters |
| Name |
Type |
Description |
| connectKey |
Object |
Base64 encoded connection parameters.
| Name |
Description |
| uri |
Full URI to the server hub's oAuth endpoint. (i.e. "http://192.168.1.123/apps/api/12") |
| serverIP |
IP Address of the server hub. |
| name |
Friendly name of the server hub. |
| type |
Platform type; valid values are "hubitat", "smartthings", "homebridge". |
| token |
oAuth token of the server hub. |
| connectionType |
Communication protocol used; valid values are "http", "socket" |
| proxyIP |
IP Address of the HubConnect nodeJS server. |
| proxyPort |
Port number of the HubConnect nodeJS server service assigned to this hub. |
| useProxy |
Connect to HubConnect server? true - connect to proxy, false - connect to server hub. |
|
|
| Return JSON |
| Name |
Type |
Return Values |
| connected |
String |
"true" if the key processed successfully, "false" if it did not.
|
responseText
|
String |
Message (success/fail) to pass to the server to be displayed to the user. (HTML allowed) |
|
Note: This should re-trigger a reconnection to the server.
