Publicité
• API REST
L'API Rest permet à l'utilisateur d'obtenir des valeurs en ligne/historiques directement à partir de
l'unité de contrôle sans accéder à la WebUI. Il peut être activé/désactivé par l'administrateur dans cette
section : pour accéder aux données via l'API Rest, un jeton d'autorisation doit être fourni dans l'en-
tête d'autorisation dans chaque requête. Le jeton doit être généré sur cette page ou les informations
d'identification de l'administrateur peuvent être utilisées.
Le nombre le plus élevé qui peut être obtenu correctement via l'API Rest est 2⁵³-1 (9007199254740991)
Attention : L'API REST est activée par défaut. Si vous ne l'utilisez pas, elle peut être désactivée.
L'EN-TÊTE D'AUTORISATION DOIT ÊTRE ENVOYÉE POUR CHAQUE REQUÊTE D'API REST.
Autorisation : <restApiToken>
ou
Autorisation : YWRtaW46YWRtaW4 de base=
(YWRtaW46YWRtaW4 = jeton codé à partir des informations d'identification de l'administrateur - nom
d'utilisateur base64 : password)
POINTS DE TERMINAISON API REST DISPONIBLES :
OBTENIR
/api/v1/system-information
Le point de terminaison renvoie des informations système qui peuvent être utilisées à des fins de
diagnostic
Response:
{
"softwareVersion": "1.0.0",
"ip": "192.168.1.200",
"hostname": "scu200hs",
"deviceTime": 1669793245
}
OBTENIR
/api/v1/metadata
ou
/api/v1/metadata?object_id=X
Pour obtenir des métadonnées pour un seul dispositif
Le point de terminaison renvoie les métadonnées des dispositifs système qui contiennent tous les
dispositifs configurés avec les registres disponibles.
POST
/api/v1/data
Le point de terminaison vous permet d'obtenir des données en ligne et historiques à partir de la SCU200.
Les variables doivent être fournies dans un corps JSON d'une requête POST. Les variables peuvent être
lues à partir des descripteurs de dispositif ou du point de terminaison des métadonnées. Les ID d'objet
peuvent être lus à partir du point de terminaison des métadonnées.
{
//"data" : tableau d'objets, il est possible d'interroger pour plusieurs données à la fois
"data": [
{
SCU200 SYSTÈME DE GESTION DE L'ÉNERGIE INSITE
67
Publicité
