Modifications

Sauter à la navigation Sauter à la recherche
2 293 octets ajoutés ,  11 janvier 2015 à 15:46
aucun résumé de modification
Ligne 1 : Ligne 1 :  
{{Spark.IO-Could-API-NAV}}
 
{{Spark.IO-Could-API-NAV}}
   −
{{traduction}}
+
== introduction ==
 +
{{bloc-etroit|text=L'API du Spark Cloud est une interface de programmation REST (dite "[http://fr.wikipedia.org/wiki/Representational_State_Transfer 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 [http://fr.wikipedia.org/wiki/Transport_Layer_Security sécurité TLS].}}
 +
 
 +
<nowiki>PROTOCOLE ET HOTE HOST
 +
https://api.spark.io</nowiki>
 +
 
 +
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.
 +
 
 +
<nowiki>GET /v1/devices</nowiki>
 +
 
 +
Obtenir les information de base à propos d'un Core, incluant les variables et functions exposées.
 +
 
 +
<nowiki>GET /v1/devices/{DEVICE_ID}</nowiki>
 +
 
 +
Faire une mise-à-jour du Core, incluant le nom affiché ou le Firmware (soit en binaire, soit le code source).
 +
 
 +
<nowiki>PUT /v1/devices/{DEVICE_ID}</nowiki>
 +
 
 +
Obtenir la valeur actuelle d'une variable exposée par le Core, ex., ''GET /v1/devices/0123456789abcdef01234567/temperature''
 +
 
 +
<nowiki>GET /v1/devices/{DEVICE_ID}/{VARIABLE}</nowiki>
 +
 
 +
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''
 +
 
 +
<nowiki>POST /v1/devices/{DEVICE_ID}/{FUNCTION}</nowiki>
 +
 
 +
Ouvre un stream (flux) pour les événements envoyés par le serveur [http://www.w3.org/TR/eventsource/ Server-Sent Events] <small>(''www.w3.org'')</small>
 +
 
 +
<nowiki>GET /v1/events[/:event_name]
 +
GET /v1/devices/events[/:event_name]
 +
GET /v1/devices/{DEVICE_ID}/events[/:event_name]</nowiki>
    
{{Spark.IO-Could-API-TRAILER}}
 
{{Spark.IO-Could-API-TRAILER}}
29 918

modifications

Menu de navigation