Publicité
8.5
Settings
Class Overview:
•
Cette classe permet d'obtenir et de mettre à jour les paramètres de configuration des piscines. Il est essentiel que
les piscines existent déjà dans le système avant que leurs paramètres puissent être récupérés ou modifiés.
•
La sécurité est assurée via l'authentification de l'utilisateur ou une API key, garantissant que seuls les poolbuilders
autorisés ou les utilisateurs disposant d'une API key valide peuvent accéder aux paramètres et les modifier.
•
Aucun nouveau PoolSettings ne peut encore être créé, la piscine doit déjà exister.
Endpoints and Methods:
•
GET /publicapi/settings/?serialnumber=<serialnumber>: Récupère les paramètres d'une piscine spécifiée par son
serialnumber. Ce point de terminaison nécessite une authentification de l'utilisateur ou une API key valide.
•
GET /publicapi/settings/<pk>/: Récupère les paramètres d'une piscine spécifiée par sa clé primaire (pk). Une
authentification ou une API key valide est également requise.
•
PUT /publicapi/settings/<pk>/: Met à jour les paramètres d'une piscine identifiée par pk. Cette méthode nécessite un
corps de requête au format JSON contenant les données des paramètres, ainsi qu'une authentification ou une API key.
Parameters:
•
serialnumber: Requis pour lister les paramètres. Il identifie la piscine dont les paramètres doivent être récupérés.
•
api_key : Optionnel. Peut être utilisé pour authentifier la requête à la place d'une session utilisateur.
Method
URL
GET
https://api.Smartpoolcontrol.eu/publicapi/status/?serialnumber=00:14:2D:A8:B1:42&api_key=valid_key
GET
https://api.Smartpoolcontrol.eu/publicapi/status/1/?api_key=valid_key
(single)
POST
-
PUT
https://api.Smartpoolcontrol.eu/publicapi/status/1/
(update)
EPS NEXUS Manuel V2.1
WWW.EPSBV.EU
PUT dictionary
- )geen nieuwe
maken)
{ "api_key":
valid_key }
86
Publicité
