Modifications

== introduction ==

== introduction ==

{{bloc-etroit|text=The Spark Cloud API is a [REST API] (dite "http://fr.wikipedia.org/wiki/Representational_State_Transfer REST API]", wikipedia.fr) . REST means a lot of things, but first and foremost it means that we use the URL in the way that it's intended: as a "Uniform Resource Locator".

{{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'').

In this case, the unique "resource" in question is your Spark Core. Every Spark Core has a URL, which can be used to '''GET''' variables, '''POST''' a function call, or '''PUT''' new firmware. The variables and functions that you have written in your firmware are exposed as subresources within the Spark Core.

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.

All requests to the Spark Core come through our API server using TLS security.}}

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

   <nowiki>PROTOCOLE ET HOTE HOST

https://api.spark.io</nowiki>

https://api.spark.io</nowiki>

There are a number of API calls available, which are summarized here, and described in more detail below.

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.

List devices the currently authenticated user has access to.

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

  <nowiki>GET /v1/devices</nowiki>

  <nowiki>GET /v1/devices</nowiki>

Get basic information about the given Core, including the custom variables and functions it has exposed.

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

  <nowiki>GET /v1/devices/{DEVICE_ID}</nowiki>

  <nowiki>GET /v1/devices/{DEVICE_ID}</nowiki>

Update the Core, including the display name or the firmware (either binary or source).

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>

  <nowiki>PUT /v1/devices/{DEVICE_ID}</nowiki>

Request the current value of a variable exposed by the core, e.g., ''GET /v1/devices/0123456789abcdef01234567/temperature''

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>

  <nowiki>GET /v1/devices/{DEVICE_ID}/{VARIABLE}</nowiki>

Call a function exposed by the core, with arguments passed in request body, e.g., ''POST /v1/devices/0123456789abcdef01234567/brew''

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>

  <nowiki>POST /v1/devices/{DEVICE_ID}/{FUNCTION}</nowiki>

Open a stream of [http://www.w3.org/TR/eventsource/ Server-Sent Events] <small>(''www.w3.org'')</small>

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]

   <nowiki>GET /v1/events[/:event_name]