Cet article répertorie la documentation disponible sur l'API et présente les étapes à suivre pour développer une application pour la plateforme en fournissant un aperçu de l'API de la plateforme et des exemples de requêtes pour demander des données.
Vous aurez besoin d'une compréhension de base de HTTP et des API, ainsi que d'un utilisateur SuperAdmin.
Contenu :
- Introduction
- Documentation de l'API v3
- Enregistrement d'une application
- Installation d'une application
- Exemples d'appels
- API d'insertion de données
Introduction
L'API sécurise toutes les requêtes en utilisant un jeton de sécurité unique pour chaque application et chaque compte où l'application est installée.
Pour obtenir un jeton de sécurité, vous devrez enregistrer une application et l'installer dans l'un de vos comptes.
Documentation de l'API v3
Toute la documentation technique sur l'API est disponible sur le portail des développeurs de la plateforme : developers.dexma.com.
Enregistrement d'une application
Si vous souhaitez enregistrer une nouvelle application, suivez les étapes décrites ici.
Installation d'une application
Exemples d'appels
Avec l'application enregistrée et installée avec succès dans l'un de vos comptes, vous devriez avoir reçu le 'x-dexcell-token' et l'avoir stocké dans votre application. Avec ce jeton, vous pouvez effectuer des requêtes vers les différents points de terminaison de l'API.
Obtenir une liste de tous mes emplacements
url: https://api.dexcell.com/v3/locations
Obtenir des informations spécifiques sur un emplacement
url: https://api.dexcell.com/v3/locations/XXX (où XXX est l'un des identifiants obtenus dans l'appel précédent)
Obtenir des données de consommation électrique
Comment créer l'appel?
http://api.dexcell.com/v3/readings + "?" + tous les paramètres joints par "&"
- device_id : 3473 (id du périphérique)
- Operation : DELTA (lectures delta)
- Parameter_key : EACTIVE (clé du paramètre d'énergie active)
- Resolution : D (quotidienne). Autres : FM, TM, QH, HH, H, D, M
- De : 2016-05-08T00:00:00 (à partir de la date au format YYYY-MM-DDT00:00:00)
- À : 2016-05-10T23:59:59 (jusqu'à la date au format YYYY-MM-DDT00:00:00)
Obtenir le coût de l'électricité pour un périphérique spécifique
Comment créer l'appel?
http://api.dexcell.com/v3/cost/electrical/consumption + "?" + tous les paramètres joints par "&"
- device_id : 3473 (id du périphérique)
- Resolution : M (mensuelle). Autres : FM, TM, QH, HH, H, D, M
- De : 2016-05-08T00:00:00 (à partir de la date au format YYYY-MM-DDT00:00:00)
- À : 2016-05-10T23:59:59 (jusqu'à la date au format YYYY-MM-DDT00:00:00)
Toutes les requêtes disponibles sont décrites dans le portail des développeurs de la plateforme : developers.dexma.com.
API d'insertion de données
La plateforme EM propose une API pour insérer des données à partir d'applications externes. Cette API est basée sur HTTPS et JSON.
Consultez cet article pour apprendre comment insérer des données dans votre compte via l'API HTTPS/JSON.