Spark-Could-API-Events

De MCHobby - Wiki
Sauter à la navigation Sauter à la recherche


MCHobby investit du temps et de l'argent dans la réalisation de traduction et/ou documentation. C'est un travail long et fastidieux réalisé dans l'esprit Open-Source... donc gratuit et librement accessible.
SI vous aimez nos traductions et documentations ALORS aidez nous à en produire plus en achetant vos produits chez MCHobby.

Enregistrer un CallBack

Dans la section build du site web de Spark, vous serez capable d'enregistrer une URL vers votre propre serveur... une URL vers laquelle Spark effectuera un POST à chaque fois que votre Spark Cores publiera certain évènement.

Souscrire un événement

Vous pouvez faire un appel d'API qui ouvre un flux (stream) de type Server-Sent Events (SSEs). Vous ferez un appel d'API qui ouvre une connexion vers Spark Cloud. Au contraire d'un appel HTTP normal qui ferme la connexion le plus rapidement possible, cette connexion SSE restera ouverte. Très peu d'information sera envoyé par cette connexion à moins que votre Spark Core ne publie un évènement, auquel cas vous serez immédiatement notifié.

Pour souscrire (subscribe) à un flux (stream) d’évènement, faite une requête GET sur un des points de contact suivant (endpoint). Cela ouvre un flux Server-Sent Events (SSE), par exemple, un socket TCP qui peu rester ouvert. Dans tous les cas, le nom de l’évènement à filtrer (dans l'URI) est optionnel. Lorsque vous spécifiez un filtre "nom d’évènement", les évènements publiés seront limités à ceux commençant par la chaine de caractère (celle spécifiée comme filtre). Par exemple, si vous spécifiez 'temp' comme filtre, vous recevrez les évènements ayant avec les noms 'temp' et 'temperature'.

Ressources SSE:

Souscrire au flux des évènements publiques, plus les évènements privés publiés par vos Cores:

GET /v1/events[/:nom_evenement]

# EXEMPLE
curl -H "Authorization: Bearer 38bb7b318cc6898c80317decb34525844bc9db55"
https://api.spark.io/v1/events/temperature

Souscrire à tous les évènement, publiques et privés, publiés par vos Cores:

GET /v1/devices/events[/:nom_evenement]

# EXEMPLE
curl -H "Authorization: Bearer 38bb7b318cc6898c80317decb34525844bc9db55"
https://api.spark.io/v1/devices/events/temperature

Souscrire aux événements d'un Core Spécifique. Si l'utilisateur de l'API possède le Core alors il recevra tous les évènements, publiques et privés, publié par le Core. Si l'utilisateur de l'API ne possède pas le Core il recevra uniquement les événements publiques.

GET /v1/devices/:core_id/events[/:nom_evenement]

# EXEMPLE
curl -H "Authorization: Bearer 38bb7b318cc6898c80317decb34525844bc9db55"
https://api.spark.io/v1/devices/55ff70064939494339432586/events/temperature

Source: Cloud CODE (API) créé par Spark.IO.

Traduction réalisée par Meurisse D pour MCHobby.be - Translated by Meurisse D. for MCHobby.be

Traduit avec l'autorisation de Spark.IO - Translated with the permission from Spark.IO - Spark.IO

Toute référence, mention ou extrait de cette traduction doit être explicitement accompagné du texte suivant : «  Traduction par MCHobby (www.MCHobby.be) - Vente de kit et composants » avec un lien vers la source (donc cette page) et ce quelque soit le média utilisé.

L'utilisation commercial de la traduction (texte) et/ou réalisation, même partielle, pourrait être soumis à redevance. Dans tous les cas de figures, vous devez également obtenir l'accord du(des) détenteur initial des droits. Celui de MC Hobby s'arrêtant au travail de traduction proprement dit.