Spark-Cloud-API

De MCHobby - Wiki
Aller à : navigation, rechercher

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.

introduction

L'API du Spark Cloud est une interface de programmation REST (dite "REST API", wikipedia.fr). REST signifie beaucoup de choses, mais en premier et principalement cela signifie que nous utilisons une URL dans le sens premier son intention: comme une "Uniform Resource Locator" (localisation uniforme de ressource).

Dans ce cas, la "ressource" unique en question est votre Spark Core. Chaque Spark Core à une URL, ce qui signifie qu'elle peut être utililisée avec GET pour prendre un variable, POST pour appeler une fonction ou PUT pour placer un nouveau FirmWare. Les variables et fonctions que vous avez écrit dans votre firmware son exposé comme des sous-ressourcesdans le Spark Core.

Toutes les requêtes sur le Spark Core sont réalisé par l'intermédiaire des serveur d'API de Spark en utilisant la sécurité TLS.

PROTOCOLE ET HOTE HOST
https://api.spark.io

Il y a un certains nombre d'appel API disponible, qui sont résumé ci-dessous, et décrit plus en détail ci-dessous.

Afficher la liste des périphériques auquel l'utilisateur authentifié à accès.

GET /v1/devices

Obtenir les information de base à propos d'un Core, incluant les variables et functions exposées.

GET /v1/devices/{DEVICE_ID}

Faire une mise-à-jour du Core, incluant le nom affiché ou le Firmware (soit en binaire, soit le code source).

PUT /v1/devices/{DEVICE_ID}

Obtenir la valeur actuelle d'une variable exposée par le Core, ex., GET /v1/devices/0123456789abcdef01234567/temperature

GET /v1/devices/{DEVICE_ID}/{VARIABLE}

Appeler une fonction exposé sur le Core avec les arguments passés dans le corps de la requête, ex.: POST /v1/devices/0123456789abcdef01234567/brew

POST /v1/devices/{DEVICE_ID}/{FUNCTION}

Ouvre un stream (flux) pour les événements envoyés par le serveur Server-Sent Events (www.w3.org)

GET /v1/events[/:event_name]
GET /v1/devices/events[/:event_name]
GET /v1/devices/{DEVICE_ID}/events[/:event_name]

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.