L’interface REST “Constellation” est une API HTTP permettant d’exposer les fonctionnalités de base pour les packages “virtuels”.

Avec cette interface vous pourrez via des requêtes HTTP :

  • Publier, consommer ou purger des StateObjects
  • Envoyer et recevoir des messages
  • Récupérer les settings du package « virtuel »
  • Produire des logs
  • Déclarer le “Package Descriptor” (MessageCallbacks exposés ou les types utilisés par les MC ou SO)

De ce fait un script Bash ou Powershell, une page PHP, un Arduino, ESP ou NetDuino, bref n’importe quel système, objet ou langage pouvant effectuer des appels HTTP peut être considéré comme un package (dit virtuel) de votre Constellation et produire ou consommer des StateObjects, envoyer ou recevoir des messages, écrire des logs, etc…

Généralités

Construction de l’URL

L’URL est :  <Root URI>/rest/constellation/<action>?<paramètres>

Partons du principe que votre Constellation est exposée en HTTP sur le port 8088 (sans path). On retrouvera dans le fichier de configuration la section suivante :

La “Root URI “ est donc “http://<ip ou dns>:8088/”.

Par exemple si nous sommes en local, nous pourrions écrire :

Authentification

Comme pour toutes les requêtes vers Constellation vous devez impérativement spécifier dans les headers HTTP ou dans les paramètres de l’URL (querystring), les paramètres “SentinelName”, “PackageName” et “AccessKey” pour l’authentification.

Ici votre “package virtuel” doit être déclaré dans la configuration de votre Constellation comme un véritable package, c’est à dire avec une sentinelle (dite virtuelle) et un package qui peut contenir des settings, etc…

Par exemple :

On a ici déclaré une sentinelle virtuelle “MyVirtualSentinel” qui contient le package virtuelle “MonPackageVirtuel”. Ce package utilise implicitement l’AccessKey du credential “Standard” déclaré au niveau de la sentinelle.

De ce fait, pour chaque appel on passera les paramètres suivants (dans l’URL ou dans les headers) :

  • SentinelName = MyVirtualSentinel
  • PackageName = MyVirtualPackage
  • AccessKey = MyAccessKey (en partant du principe que l’AccessKey déclaré pour le credential “Standard” est “MyAccessKey”)

Pour la suite de cet article nous passerons tous les paramètres dans l’URL, ainsi chaque appel sera sous la forme :

Check Access

Toutes les API REST de Constellation exposent une méthode en GET “CheckAccess” qui retourne un code HTTP 200 (OK). Cela permet de tester la connexion et l’authentification au serveur Constellation.

  • Action : “CheckAccess” (GET)
  • Paramètres : aucun

Exemple :

Publier des StateObjects

  • Action : “PushStateObject” (GET ou POST)
  • En GET, voici les paramètres de l’URL :
    • name : le nom du StateObject
    • value : la valeur du StateObject
    • type (optionnel) : le type du StateObject
    • lifetime (optionnel – par défaut 0) : la durée de vie (en seconde) du StateObject avant d’être marqué “expiré”. (0 = durée de vie infinie)

Pour publier un StateObject vous devez obligatoirement spécifier son nom (name) et sa valeur (value). La valeur peut être un type simple (un Int, String, bool, etc..) ou un objet complexe formaté en JSON. Optionnellement vous pouvez spécifier le type et la durée de vie de votre SO (en seconde).

Par exemple publions un StateObject nommé “Temperature” dont la valeur est le nombre “21” :

Autre exemple avec un objet complexe contenant deux propriété (Temperature et Humidity) dont la durée de vie est de 60 secondes et le type nommé “TemperatureHumidity” :

Si la valeur du StateObject est trop grande pour être passée dans l’URL ou si vous souhaitez ajouter des métadonnées (metadatas) à votre StateObject vous pouvez “poster” le StateObject dans le corps de la requête HTTP en utilisant le verbe “POST” (sans oublier de définir le Content-Type à “application/json”).

Pour publier par un POST le même StateObject en lui ajoutant deux métadonnées :

Purger ses StateObjects

Un package peut supprimer ses StateObjects qu’il produit avec la méthode “PurgeStateObjects”.

  • Action : “PurgeStateObjects” (GET)
  • Paramètres:
    • name (optionnel – par défaut “*”) : le nom du StateObject
    • type (optionnel – par défaut “*”) : le type du StateObject

Vous pouvez spécifier le nom du StateObject à supprimer et/ou son type. Par défaut ces deux paramètres sont définis à “*”. C’est à dire que si vous ne précisez rien, tous les StateObjects du package seront purgés.

Par exemple pour purger tous les StateObjects de notre package virtuel (instance MyVirtualSentinel/MyVirtualPackage):

Pour purger tous les StateObjects de type “Temperature” de cette même instance :

Ou pour supprimer le StateObject nommé “Demo” :

Ecrire des logs

Les packages peuvent écrire des logs qui seront remontés dans le hub Constellation.

  • Action : “WriteLog” (GET)
  • Paramètres:
    • message : texte du log
    • level (optionnel – par défaut “Info”) : le niveau du log (Info, Warn ou Error)

Exemple d’un message “Info” :

Exemple pour produire un message d’erreur (Error) :

Récupérer ses settings

Les settings sont récupérés en invoquant la méthode “GetSettings”.

  • Action : “GetSettings” (GET)
  • Paramètres:  aucun

Par exemple pour récupérer les settings (dictionnaire de clé / valeur) définis pour notre package virtuel :

Envoyer des messages

  • Action : “SendMessage” (GET ou POST)
  • En GET, voici les paramètres de l’URL :
    • scope : le type de scope (All, Other, Group, Sentinel ou Package)
    • args : les arguments du scope (par exemple le nom du groupe, de la sentinelle, du package ou de l’instance du package – plusieurs valeurs possibles séparées par des virgules)
    • key : la clé du message (= la méthode à invoquer)
    • data : le contenu du message (= les arguments de la méthode)
    • sagaId (optionnel) : l’identification de la saga si le message est envoyé dans une saga

Vous pouvez également invoquer cette action en POST. Le corps de votre requête contiendra l’objet JSON suivant :

La propriété “SagaId” dans le JSON ci-dessus est optionnelle.

Par exemple pour envoyer un message au package Nest en invoquant la méthode (key) “SetTargetTemperature” avec en paramètre le nombre “21” :

Ce même MessageCallback “SetTargetTemperature” du package Nest peut être invoqué dans une saga afin de recevoir un accusé de réception :

Il faudra ensuite “récupérer” les messages reçus (voir dessous) pour lire la réponse à votre saga que nous avons ici identifié par la clé “123456789”.

Recevoir des messages

Créer un abonnement de réception

Tout d’abord pour recevoir des messages il faut s’abonner aux messages.

  • Action : “SubscribeToMessage” (GET)
  • Paramètres :
    • subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu

Vous obtiendrez en réponse l’ID de votre abonnement, le “Subscription Id”.

Relever les messages

  • Action : “GetMessages” (GET)
  • Paramètres :
    • subscriptionId : identifiant de l’abonnement
    • timeout (optionnel – par défaut 60000) : temps maximal en milliseconde de la mise en attente de la requête (entre 1000ms et 120000ms)
    • limit (optionnel – par défaut 0) : nombre maximum de message à retourner pour l’appel

Il s’agit d’une requête en “long-polling” c’est à dire que la requête sera “bloquée” sur le serveur tant qu’il n’y a pas de message reçu évitant ainsi de “flooder” en continue le serveur pour savoir si de nouveaux messages sont disponibles ou non. Par défaut la requête est bloquée 60 secondes maximum mais vous pouvez personnaliser cette valeur avec le paramètre “timeout”. Si il y a des messages disponibles, le serveur vous renvoi un tableau JSON avec les messages reçus. Si il n’y a pas de réponse dans le délai spécifié par le paramètre “timeout” (60 secondes par défaut), le tableau retourné sera vide.

A chaque réponse vous devez donc relancer une requête “GetMessages” pour “écouter” les prochains messages qui vont sont destinés.

Il est également possible de limiter le nombre de message dans la réponse avec le paramètre “limit” ce qui peut être utile sur de petits “devices” ne disposant pas de beaucoup de mémoire RAM pour désérialiser de gros tableaux JSON.

Exemple simple :

Autre exemple en limitant le nombre de message à 2 par appel et en bloquant la requête pendant 10 secondes au maximum :

S’abonner à un groupe

Vous pouvez vous abonner à des groupes pour recevoir les messages envoyés dans ces groupes par l’action “SubscribeToMessageGroup” en précisant le nom du groupe et votre ID d’abonnement.

  • Action : “SubscribeToMessageGroup” (GET)
  • Paramètres :
    • group : le nom du groupe à joindre
    • subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu

Comme l’action “SubscribeToMessage”, cette action vous retourne l’ID d’abonnement à utiliser pour l’action “GetMessages”.

Consommation de StateObjects

Request

Cette méthode permet de récupérer la valeur actuelle d’un ou de plusieurs StateObjects.

  • Action : “RequestStateObjects” (GET)
  • Paramètres :
    • sentinel (optionnel – par défaut “*”): nom de la sentinelle
    • package (optionnel – par défaut “*”) : nom du package
    • name (optionnel – par défaut “*”) : nom du StateObject
    • type (optionnel – par défaut “*”) : type du StateObject

Par exemple pour récupérer tous les StateObject de votre Constellation :

Ou seulement ceux produits par le package “HWMonitor” (quelque soit la sentinelle) :

Ou encore tous les StateObjects nommés “/intelcpu/load/0” et produits le package “HWMonitor” (quelque soit la sentinelle) :

Subscribe

Vous pouvez également vous abonner aux mises à jour des StateObjects.

Le principe est le même qu’avec les messages : il faut récupérer un ID d’abonnement et invoquer une méthode en long-polling pour recevoir les mises à jour.

S’abonner à des StateObjects
  • Action : “SubscribeToStateObjects” (GET)
  • Paramètres :
    • subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu
    • sentinel (optionnel – par défaut “*”): nom de la sentinelle
    • package (optionnel – par défaut “*”) : nom du package
    • name (optionnel – par défaut “*”) : nom du StateObject
    • type (optionnel – par défaut “*”) : type du StateObject

En retour vous obtiendrez l’ID d’abonnement (un GUID).

Par exemple pour s’abonner au SO “/intelcpu/load/0”, produit le package “HWMonitor” sur la sentinelle “MON-PC” :

ATTENTION : si vous souhaitez “ajouter” des SO à votre abonnement vous devez impérativement préciser votre ID d’abonnement récupéré lors du 1er appel autrement vous allez créer un nouvel abonnement.

Par exemple pour “ajouter” le SO correspondant à la consommation RAM :

Relever les StateObjects mis à jour

Pour récupérer les SO de votre abonnement qui ont changés entre deux appels vous devez invoquer l’action “GetStateObjects” en spécifiant l’ID de votre abonnement :

  • Action : “GetStateObjects” (GET)
  • Paramètres :
    • subscriptionId : identifiant de l’abonnement
    • timeout (optionnel – par défaut 60000) : temps maximal en milliseconde de la mise en attente de la requête (entre 1000ms et 120000ms)
    • limit (optionnel – par défaut 0) : nombre maximum de message à retourner pour l’appel

Comme pour les messages, vous pouvez limiter le nombre de SO (limit) et le timeout de la requête (timeout).

Notez que si un StateObject pour lequel vous êtes abonné change plusieurs fois entre deux appels “GetStateObjects”, vous obtiendrez la dernière valeur et non l’historique de tous les changements.

Déclarer le “Package Descriptor”

Action : “DeclarePackageDescriptor” (POST)

Le “Package Descriptor” permet décrire les MessagesCallbacks d’un package ainsi que les types utilisés par ses MC ou StateObjects.

Ainsi en publiant le PackageDescriptor, la Constellation aura connaissance des MessageCallbacks qu’expose un package ainsi que le type des StateObject qu’il publie. C’est grâce au Package Descriiptor que fonctionne le “MessageCallback Explorer” de la Console Constellation.

Le Package Descriptor est un objet JSON contenant :

  • Le nom du package
  • La liste des MessageCallbacks du package
  • La liste des types utilisés par les MessageCallbacks du package
  • La liste des types utilisés par les StateObjects publiés par le package

La structure de base est donc :

Chaque “MessageCallback” est un objet contenant :

  • MessageKey : la clé du message (le nom/clé du MessageCallback)
  • Description (optionnel) : description du MessageCallback
  • ResponseType (optionnel) : le type du message de retour dans le cas où le MC répond au Saga
  • Parameters (optionnel) : la liste des paramètres du MC

Un paramètre est décrit par un objet contenant :

  • Name : le nom du paramètre
  • TypeName : le type du paramètre
  • Description (optionnel) : la description du paramètre
  • Type : le type de paramètre (doit être obligatoirement défini à 2 pour un paramètre d’un MC)
  • IsOptional (optionnel) : booléen (true ou false) qui indique si le paramètre est optionnel ou non
  • DefaultValue (optionnel) : la valeur par défaut du paramètre si optionnel

Le type d’un paramètre peut être un type simple décrit par les types .NET (System.Int16, System.Int32, System.Int64, System.Double, System.Decimal, System.Float, System.Boolean, System.String) ou un type personnalisé.

Les types personnalisés utilisés dans les paramètres des MC seront décrits dans la propriété “MessageCallbackTypes” du Package Descriptor et les types personnalisés utilisés pour les StateObjects seront décrits dans la propriété “StateObjectTypes” du Package Descriptor.

Dans les deux cas il s’agit de la même structure de donnée.

La description d’un type est un objet contenant :

  • TypeName : le nom du type (l’identifiant)
  • TypeFullname : le nom complet du type (utilisé pour identifier le nom complet d’un type .NET par exemple)
  • Description (optionnel) : la description du type
  • IsGeneric (optionnel) : booléen (true ou false) qui indique si le type est un type générique
  • IsArray (optionnel) : booléen (true ou false) qui indique si le type est un tableau
  • GenericParameters (optionnel) : la liste des types génériques si il s’agit d’un type générique ou d’un tableau
  • IsEnum (optionnel) : booléen (true ou false) qui indique si le type est une énumération
  • EnumValues (optionnel) : la liste des valeurs de l’énumérations si le type est une énumération
  • Properties (optionnel) : la liste des propriétés du type

Les propriétés d’un type tout comme les valeurs d’une énumération sont décrits de la même manière qu’un paramètre d’un MessageCallback déjà détaillé ci-dessus.

Seule la propriété “Type” change :

  • Type = 0 : pour décrire une propriété
  • Type = 1 : pour décrire une valeur d’une énumération
  • Type = 2 : pour décrire une paramètre d’un MessageCallback comme expliqué précédemment

Exemple 1 – Package “NetworkTools”

Voici le Package Descriptor du package “NetworkTools” :

Exemple 2 – Package “Paradox”

Autre exemple plus complet, le Package Descriptor du package “Paradox” :

L’interface REST « Constellation »
Editer la page sur GitHub
Étiqueté avec :                                                                            

Sur le forum :

  1. Dans la partie CheckAccess, bien rajouter l’édition de la sentinel après édition de la configuration, dans la partie Sentinels, Editer, et bien choisir les droits.

Continuez la discussion sur le forum Constellation

Participants