Webservice/API Envoyer et récupérer des relevés de consommation d'énergie

Sommaire des fonctionnalités API

- GetVersion (Récupérer la version)
- Login (Se connecter ou s'identifier)
- AddData (Envoyer des relevés)
- GetStat (Récupérer des statistiques)
- Vos commentaires et suggestions?

Explication

Le protocole de communication WSDL (SOAP) permet de communiquer avec Michamps-4B.

Il permet d'envoyer des relevés, récupérer des statistiques très facilement.

Documentation des fonctionnalités

• Récupérer la version du WebService

IDVERSION = GetVersion ( LOGIN)

IDVERSION: Numéro de version

Cet Api/Webservice est appélé à évoluer, La fonctionnalité GetVersion permet de suivre l'évolution des changements

Version:

1.03(mars 2014) : extension à 100 relevés par jour et par compteur,
- Envoyer des relevés de pellets

1.02: Version Initiale avec 4 fonctions disponibles :
Login,AddData,GetStat,GetVersion

• 1^ère étape: Se connecter ou s'identifier

IDCONNECT = Login ( LOGIN , MOT-PASSE )

IDCONNECT: Identifiant de connection, "0" si non connecté
LOGIN: Le nom de votre login
MOT-PASSE: à remplacer par votre mot de passe

Exemple Php:

<?php

$client = new SoapClient('http://www.michamps4b.be/webservice.wsdl');
$IDCONNECT = $client->Login ('demo','demo');
echo $IDCONNECT;

?>

Si vous lancer cette fonction, vous obtiendrez comme résultat: Ok demo

• Envoyer des relevés (utile pour la domotique par exemple)

RESULT = AddData ( IDCONNECT , RELEVEXML )

Attention: Chaque jour, vous pouvez envoyer jusque 50 relevés par énérgie (soit un toutes les demi-heures).

RESULT: En cas de réussite, la fonction retourne SUCCESS, sinon un message d'erreur se trouvera dans ce message.

IDCONNECT: Identifiant de connection (voir Login)
RELEVEXML: A l'intérieur d'une balise "Data", vous pouvez placer les index suivant les types de compteurs (complet par type)

<CEJ> = Index du compteur d'électricité Jour
<CEN> = Index du compteur d'électricité de Nuit
<CEP> = Index du compteur de production
<CEC> = Index du compteur de chauffage exclusif
<EAU> = Index du compteur d'eau
<GAZ> = Index du compteur de gaz
<PELLET> = Quantité en Pellets (en Kg) NOUVEAU

Exemple Php: Envoie de relevés d'électricité Jour et nuit

<?php

$client = new SoapClient('http://www.michamps4b.be/webservice.wsdl');
$IDCONNECT = $client->Login ('votrelogin','motdepasse');

$MESINDEX = '<DATA><CEJ>40000</CEJ><CEN>60000</CEN></DATA>';

$VALRETOUR = $client->AddData ($IDCONNECT,$MESINDEX);
echo $VALRETOUR;

// Envoyer des relevés de pelllets (5,2 Kg)

$MESINDEX = '<DATA><PELLET>5.2</PELLET></DATA>';

$VALRETOUR = $client->AddData ($IDCONNECT,$MESINDEX);
echo $VALRETOUR;

?>

• Récupérer des statistiques (domotique et API)

MESSTAT = GetStat ( IDCONNECT)

Cette fonction renvoie toutes les statistiques correspondant à votre habitation, y compris les groupes et autres résidences.

<MESSTAT> = Retourne la structure en format XML
(possibilité d'autres formats)

Résultat XML:
<ALLDATA>
   <LOGIN value="[IDENT]"> (tous vos logins associés + groupe + déménagement)
    <ENERGY value="[TYPE]"> (Type: E= Electricité, A=Eau, G=Gaz, P=Production)
       <ANNEE value="[ANNEE]"> (Année de consommation)

         <METER value="[COMPTEUR]"> (Type de compteur)
           <DATE DT="[DATE]">[VALUE]</DATE>
            [DATE]: Format jour-mois-annee
            [VALUE]: Valeur consommée ou produite
         </METER>

       </ANNEE>
    </ENERGY>
   </LOGIN>

   <LOGIN value="[IDENT]">
...
   </LOGIN>
</ALLDATA>

Exemple Php: Récupération de toutes les statistiques de consommation d'énergie

<?php

$client = new SoapClient('http://www.michamps4b.be/webservice.wsdl');
$IDCONNECT = $client->Login ('votrelogin','motdepasse');

$MESCONSO = $client->GetStat ($IDCONNECT);
echo htmlspecialchars ($MESCONSO);

?>

Cette fonction retourne toutes vos consommations d'énergie, + celle de votre groupe si vous êtes administrateur, + seconde résidence + démémagement