EcoAdaptor for Nest API
This API is for the EcoAdaptor for Nest which provides for federation and defederation with Nest cloud services
For more information about the flow of federation and defederation as well as how to obtain and set values from and on the Nest Cloud please refer to the EcoAdaptor for Nest Guide
POST /federatedtokens
POST /federatedtokens
Submits an oauth token obtained from Nest to the EcoAdaptor for Nest service
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
secToken |
body |
Arrayent Cloud (ACC) security token of user federating with Nest | Yes | String |
anEcosystemName |
body |
Hardcoded as “Nest” | Yes | String |
anAccessToken |
body |
Oauth token obtained from Nest | Yes | String |
Responses
| Code | Description | Schema |
|---|---|---|
200 |
OK | |
500 |
Error inserting the oauth token, may need to use PUT instead of POST for updating | { |
PUT /federatedtokens
PUT /federatedtokens
Updates an existing token with a new one in the EcoAdaptor for Nest service
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
secToken |
body |
Arrayent Cloud (ACC) security token of user federating with Nest | Yes | String |
anEcosystemName |
body |
Hardcoded as “Nest” | Yes | String |
anAccessToken |
body |
Oauth token obtained from Nest | Yes | String |
Response
| Code | Description | Schema |
|---|---|---|
200 |
OK | |
500 |
Error updating the oauth token | { |
DELETE /federatedtokens
DELETE /federatedtokens
Defederates from Nest, removing all information about the previously federated Nest account
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
secToken |
body |
Arrayent Cloud (ACC) security token of user federating with Nest | Yes | String |
anEcosystemName |
body |
Hardcoded as “Nest” | Yes | String |
Response
| Code | Description | Schema |
|---|---|---|
200 |
OK | |
500 |
Error removing the federation | { |
GET/federatedtokens
GET /federatedtokens
Use this API to determine if the account specified is already federated with Nest or not. If it is returns OK otherwise a descriptive error message.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
secToken |
body |
Arrayent Cloud (ACC) security token of user to check if already federated with Nest | Yes | String |
anEcosystemName |
body |
Hardcoded as “Nest” | Yes | String |
Response
| Code | Description | Schema |
|---|---|---|
200 |
OK | |
500 |
Error | { |