Getting Started with Evercloud API

Have more questions? Submit a request

Overview

The Everactive API consists of two modules: a RESTful API for querying and updating data, and webhooks for consuming events related to your equipment.

 

REST API

The Everactive REST API allows you to perform queries and updates for your equipment monitored by Everactive.

To use the Everactive API you must obtain authorization client credentials. At this time, authorization client credentials are available to Everactive partners and can be obtained by contacting Everactive.

The credentials consist of a client ID and client secret combination. The client ID/client secret combination is only intended for server-side integrations with the Everactive API. The client secret must be protected and hidden from end users. It is the responsibility of developers integrating their backend systems with Everactive to keep the client secret secure.

 

Webhooks

The Everactive API allows clients to subscribe to updates for certain events.

When an event is detected, Everactive's webhook sends a an HTTP POST request to an endpoint you designated when creating your subscription. The details specific to the event are transferred as a JSON payload in the POST body.

 

 

Authentication

The Everactive REST API uses OAuth2 (https://tools.ietf.org/html/rfc6749) to authenticate requests with two security schemes: client credentials and password.

 

Client Credentials

The client credentials grant type is used when the system authenticating to the API is not on behalf of a user. Backend system to system integrations shall use the client credentials grant type. An explanation of the client credentials grant type and access token flow can be found at https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/.

 

Password

The password grant type is used when an authentication request is made on behalf of a user. User-facing clients (such as Everactive's Insights) use the password grant type. An explanation of the password grant type and access token flow can be found at https://www.oauth.com/oauth2-servers/access-tokens/password-grant/.

 

To gain access to your credentials and password- send a request to success@everactive.com

 

Full Documentation of Everactive's API is available here:  https://api-spec.data.everactive.com/

 

Articles in this section

Was this article helpful?
1 out of 1 found this helpful
Share

Comments

0 comments

Please sign in to leave a comment.