Publicité
8.2
API Endpoints Overview
8.2.1 Realtime Data
Endpoints:
•
GET /publicapi/realtimedata/: Realtime measurement of one pool, requiring a pool serialnumber and optional api_key for access.
•
GET /publicapi/realtimedata/<pk>/: Retrieves a single real-time measurement by its primary key (pk), with optional api_key for access.
•
PUT /publicapi/realtimedata/<pk>/: Updates a single real-time measurement by its primary key (pk), requiring request data in JSON format
and an optional api_key
Parameters:
•
serialnumber : Le numéro de série de la piscine pour laquelle les mesures doivent être listées ou mises à jour.
•
api_key : Une key API optionnelle pour l'authentification, offrant une alternative aux utilisateurs connectés.
Method
URL
GET
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/?serialnumber=00:14:2D:A8:B1:42&api_key=valid_key
GET
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/1/?api_key=valid_key
(single)
POST
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/1/
PUT
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/1/
(update)
Pour comprendre la logique derrière cela :
Une seule piscine/mesure/donnée historique est toujours accompagnée du serialnumber (ID de la base de données) à la fin.
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/1/
Pour obtenir la liste de toutes les mesures de la piscine, il suffit de ne pas inclure le serialnumber.
http://api.Smartpoolcontrol.eu/publicapi/realtimedata/
Une requête GET (pour obtenir une piscine) doit inclure toutes les variables (api_key, serialnumber) dans le lien.
http://api.Smartpoolcontrol.eu/publicapi/realtimedata/?serialnumber=00:14:2D:A8:B1:42&api_key=valid_key
Avec les requêtes POST et PUT, les variables sont dans le dictionnaire JSON, donc le lien lui-même peut rester propre comme ceci :
https://api.Smartpoolcontrol.eu/publicapi/realtimedata/1/
C'est pareil pour Historicaldata, Configuration, Status, et Settings.
EPS NEXUS Manuel V2.1
WWW.EPSBV.EU
POST /
|PUT
dictionary
{
"api_key":
valid_key
}
{
"api_key":
valid_key}
82
Publicité
