eGreen REST API DOCUMENTATION

eGreen REST API
DOCUMENTATION
JUIN 2013
SOMMAIRE
eGreen®
1.
A QUOI SERT L’API EGREEN
2.
RECUPERER LA CLÉ D’API
3.
ENVOYER DES DONNÉES
eGreen REST API - DOCUMENTATION
A QUOI SERT L’API EGREEN
1.
L'API eGreen est utilisée pour échanger de manière sécurisée et fiable les données entre le dispositif
technique de mesure des consommations d’énergie et les serveurs distants d’eGreen. Ces données
sont ensuite stockées puis traitées afin d’offrir aux utilisateurs une plateforme d’aide à la réduction
des consommations d’énergie à travers un espace internet dédié sur le site egreen.fr.
2.
RECUPERER LA CLÉ D’API
Afin de pouvoir communiquer avec le l'API d'eGreen, il est nécessaire de faire la demande d'une clé
d'API. Pour cela, envoyez-nous un email à [email protected].
Cette clé, vous sera fournie accompagnée d'un code secret utile pour l'authentification lors des
envois de données.
3.
ENVOYER DES DONNÉES
3.1. Principe
Actuellement seul l'envoi de données est autorisé. Il n'est donc pas possible de les récupérer ou de
les modifier. Vous pourrez néanmoins télécharger l’ensemble de vos données sur la plateforme
eGreen au format .xls ou .csv.
Pour pouvoir envoyer les données il suffit de procéder de la manière décrite ci-dessous.
•
Les données doivent être envoyées à l'adresse suivante :
https://rest.egreen.fr/energy/create
•
Elles doivent être passées en utilisant la méthode POST.
•
Le nom des paramètres à passer sont les suivants :
o
o
o
o
eGreen®
apiKey
sig
sensorId
recDate (YYYY-mm-dd)
eGreen REST API - DOCUMENTATION
•
•
o recTime (hh:mm)
Un des deux paramètres suivant est obligatoire, suivant le type de données envoyé
o consoEnergy : dans le cas d’une consommation d’énergie calculée depuis le dernier
envoie ou dans le cas de données de température
o sensorValue : dans le cas d’un index de consommation (une différence sera faite de
notre côté avec le dernier index reçu pour calculer la consommation d’énergie)
Le paramètre sig correspond à un hash calculé en utilisant l'algorithme MD5.
La string à passer pour calculer ce hash est la suivante :
api_secretapiKeyapi_keysensorIdsensor_idenergyTypeenergy_typeconsoEnergyconso_energ
y_or_sensor_value
Ce qui est en italique est à remplacer par les valeurs des paramètres de la requête et ce qui
est en gras doit être écrit tel quel. L'api_secret correspond au code qui vous a été fourni avec
votre clé d'API.
« conso_energy_or_senosr_value » est à remplacer par celui des deux paramètres que vous
avez décidé d’envoyer.
3.2. Exemple de calcul du hash
Supposons que nous voulons ajouter une entrée aves les paramètres suivants :
•
api_key = 1234
•
api_secret = 5678
•
sensor_id = 643300
•
energy_type = electricity
•
conso_energy = 25
Le hash se calculera donc de la façon suivante :
$sig = md5(5678apiKey1234sensorId643300energyTypeelectricityconsoEnergy25) ;
Ceci est un exemple de calcul du paramètre sig en php.
Une question ? Besoin d’aide ? N’hésitez pas à nous contacter par mail [email protected]
eGreen®
eGreen REST API - DOCUMENTATION