Spark-Could-API-Auth
Authentification
Ce n'est pas parce que vous avez connecté votre Spark Core sur Internet que n'importe qui peut y accéder. Les permissions permettant de contrôler et communiquer avec le Spark Core sont gérés avec OAuth2 (Wikipedia, Français).
# Vous tapez ceci dans votre terminal
curl https://api.spark.io/v1/devices/0123456789abcdef01234567/brew \
-d access_token=9876987698769876987698769876987698769876
# Réponse: Statut 200 OK, ce qui signifie que votre
# Core dit "Oui, monsieur!"
# Si Sneaky Pete essaye la même chose dans son terminal
# Notez que Sneaky utilise son propre access_token (celui mentionné
# dans son environnement Spark Build)
curl https://api.spark.io/v1/devices/0123456789abcdef01234567/brew \
-d access_token=1234123412341234123412341234123412341234
# Réponse: Statut 403 Forbidden, signifiant que votre
# Core répond "Tu n'est pas mon maître."
# Morale de cet exemple: *** protégez votre access_token ***
Lorsque vous connectez votre Spark Core sur le Cloud pour la première fois, is sera associé à votre compte Spark. Seulement après cette opération vous aurez la permission de contrôler Spark Core en utilisant votre access token.
Si vous voulez transférer la propriété de votre Core à un autre utilisateur, la façon la plus simple est encore de vous connecter sur le site de Spark build, de cliquer sur l'icon 'Cores' en bas à gauche puis de cliquer sur la petite flèche à côté du Core à transférer.
Vous pourrez ainsi cliquer sur le bouton "Remove Core" (retirer le Core) afin qu'il ne soit plus associé à votre compte Spark.
Cette opération réalisée, vous pouvez alors donner votre Core et la personne qui le recevra pourra utiliser le processus de déclaration (claiming) normalement, comme s'il s'agissait d'un Core tout neuf.
Dans le futur, vous serez capable d'offrir un accès à votre Core à d'autre comptes et à des développeurs d'application; Cependant, cette fonctionnalité n'est pas encore disponible.
Comment envoyer votre access_token
Il y a trois façons différentes d'envoyer un access token (jeton d'accès) dans une requête.
- Dans l'entête d'autorisation HTTP (HTTP Authorization header). Fonctionne toujours.
- Inlus dans l'URL de la requête (dans la query string). Fonctionne uniquement avec les requêtes GET.
- Dans le corps de la requête. Fonctionne uniquement avec POST et PUT lorsque l'URL est encodée dans le corps (content request).
Dans ces documents, vous allez voir des exemples d'appel utilisant le programme CURL en ligne de commande. CURL est disponible sur toutes les plateformes.
Les commandes d'exemples vont toujours commencer avec curl.
Dans l'entête HTTP
curl -H "Authorization: Bearer 38bb7b318cc6898c80317decb34525844bc9db55" https://...
Utiliser le flag/drapeau pour envoyer une entête personnalisée en utilisant CURL. Le token d'accès est appelé un jeton "Bearer" et prends place dans l'entête d'autorisation HTTP standard (standard HTTP Authorization header).
Dans la Query String
curl https://api.spark.io/v1/devices\?access_token=38bb7b318cc6898c80317decb34525844bc9db55
La query string est la partie de l'URL après le point d'interrogation (?). Pour envoyer un access token dans la "query string" ajoutez simplement access_token=38bb....
Note: étant donné que le terminal va interpréter le ? comme un caractère spécial de remplacement, nous devons utiliser la séquence d'échappement (\?).
Dans le corps de requête
curl -d access_token=38bb7b318cc6898c80317decb34525844bc9db55 https://...
Le corps de requête (content request) est la façon dont un formulaire est soumis sur le Web (élément html FORM). En utilisant curl, chaque paramètre que vous voulez envoyer (incluant l'access token) doit être précédé du flag/drapeau -d.
Par défaut, si vous ajoutez un flag/drapeau -d alors CURL considère que vous voulez faire une requête de type POST. Si vous avez besoin d'indiquer un type de requête différent alors vous pouvez utiliser le flag/drapeau -X (ex: -X PUT).
Générer un nouvel access_token
Lorsque vous créez un nouvel access token, vous devez spécifier plusieurs informations complémentaires.
POST /oauth/token
Vous devez fournir un client ID et un mot de passe valide dans l'entête d’authentification HTTP (HTTP Basic Auth). N'importe quel Client ID fonctionnera pour le moment, Spark suggère d'utiliser spark:spark (utilisateur:mot_de_passe). Dans le corps de la requête, vous aurez besoin de trois paramètres:
- grant_type=password
- username=VOTRE_EMAIL@ADRES.SE
- password=VOTRE_MOT_DE_PASSE
# En utilisant Curl en ligne de commande
curl https://api.spark.io/oauth/token -u spark:spark \
-d grant_type=password -d username=joe@example.com -d password=SuperSecret
# Exemple typique de réponse JSON:
{
"access_token": "254406f79c1999af65a7df4388971354f85cfee9",
"token_type": "bearer",
"expires_in": 7776000
}
A partir de maintenant, Spark Build affichera le dernier token créé (le plus récent).
Note #1 de MCHobby: Le mot "Bearer" signifie titulaire. L'access_token généré permet d'accéder en tant que titulaire.
Note #2 de MCHobby: Admettons que nous utilisons l'appel suivant:
curl https://api.spark.io/oauth/token -u xyz:xyz \
-d grant_type=password -d username=votre_adresse@email.com -d password=votre_mot_de_passe_Spark
Lorsque vous listerez vos cores (voir ci-dessous), vous verrez apparaitre "client: xyz" comme identification du client!
Si vous exécutez plusieurs fois la commande curl, vous obtiendrez plusieurs access_token différent MAIS TOUS VALIDES. Ils apparaitrons tous dans la liste des access_token.
Lister tous vos tokens
Vous pouvez lister tous vos access token en passant votre adresse e-mail et mot de passe dans l'entête Auth de la requête. Requête adressée à /v1/access_tokens.
GET /v1/access_tokens
# En utilisant curl en ligne de commande
curl https://api.spark.io/v1/access_tokens -u joe@example.com:SuperSecret
# Exemple de réponse JSON
[
{
"token": "b5b901e8760164e134199bc2c3dd1d228acf2d98",
"expires_at": "2014-04-27T02:20:36.177Z",
"client": "spark"
},
{
"token": "ba54b6bb71a43b7612bdc7c972914604a078892b",
"expires_at": "2014-04-27T06:31:08.991Z",
"client": "spark"
}
]
Note de MCHobby:
- Lorsque nous avons cherché l'access_token visible dans Spark Build, nous avons noté que celui-ci correspondait au token "client: user".
- Si vous utilisez Spark-CLI, ce dernier obtiendra également son propre access_token correspondant à "client: spark-cli"
- Spark IDE semble également avoir son propre access_token correspondant à "client: spark-ide"
Effacer un access_token
Si vous avez des access token inutilisé et que vous voulez les nettoyer, vous pouvez effacer ces tokens.
DELETE /v1/access_tokens/:token
Comme pour lister les access_tokens, vous devez envoyer votre nom d'utilisateur et mot de passe dans l'entête d'authentification de la requête.
# En utilisant curl en ligne de commande
curl https://api.spark.io/v1/access_tokens/b5b901e8760164e134199bc2c3dd1d228acf2d98 \
-u joe@example.com:SuperSecret -X DELETE
# Exemple de réponse JSON
{
"ok": true
}
Note de MCHobby: Durant l'écriture de nos exemples PyCall (Python Call pour Spark Core), nous avons noté qu'il était impossible d'effacer le dernier access_token crée (du moins via Python et urllib2).
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.