Introduction

These pages will provide you all information about the Smappee REST API.

Authentication

Before you can use the different API methods, you will have to authenticate yourself to the Smappee cloud. The authentication mechanism is based on oauth2 specification, for more information on the oauth2 spec see: http://oauth.net/documentation

Following calls are available to manage the authentication:

• Get token

• Refresh token

 Both calls need a "Client_id" and "Client_secret" which are user specific. For personal use, access to the API is free and credentials can be obtained by contacting support@smappee.com. For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting info@smappee.com.

API methods

Versioning

To support future changes and maintain backwards compatibility, we keep different versions of the API online. The different versions can be distinguished by the vX (where X is the version number) in the URL. The differences between the different versions are explained the different pages that are dedicated to one API call.

Common pitfalls

• Get Electricity Consumption, Get Sensor Consumption and Get Events have from / to query parameters to indicated the queried period. These values should be the UTC timestamp in milliseconds. The website https://www.epochconverter.com/ can help you to convert a readable date in an UTC timestamp.

• Get Electricity Consumption and Get Sensor Consumption require as query parameter the aggregation level. When no aggregation level is specified this will result in a 500 HTTP error.