Premiers pas avec l'API REST

Ce tutoriel explique comment activer l'accès à l'API REST Fitness, obtenir des jetons d'accès OAuth et appeler les méthodes de l'API à l'aide de requêtes HTTP.

Pour utiliser l'API REST Fitness, vous devez connaître les bases des services Web RESTful et des représentations JSON.

Obtenir un compte Google

Pour utiliser l'API REST Fitness, vous devez disposer d'un compte Google. Si vous avez déjà un compte, vous êtes prêt. Vous pouvez également créer un compte Google distinct à des fins de test.

Demander un ID client OAuth 2.0

Suivez ces étapes afin de demander un ID client OAuth 2.0 pour Fitness API.

  1. Accédez à la console Google APIs.
  2. Sélectionnez un projet ou créez-en un. Utilisez le même projet pour les versions Android et REST de votre application.
  3. Cliquez sur Continuer pour activer l'API Fitness.
  4. Cliquez sur Passer à l'étape "Identifiants".
  5. Cliquez sur Nouveaux identifiants, puis sélectionnez ID client OAuth.
  6. Sous Type d'application, sélectionnez Application Web.
  7. Sous Origines JavaScript autorisées, saisissez l'URL de base du site. d'où proviennent les requêtes (par exemple, https://developers.google.com) est l'URL utilisée par OAuth Playground).
  8. Sous URI de redirection autorisé, saisissez l'URL du site où les réponses seront gérées (par exemple, https://developers.google.com/oauthplayground est l'URL utilisée par OAuth Playground).

  9. Cliquez sur Créer. Votre nouvel ID client et votre nouveau secret OAuth 2.0 apparaissent dans la liste. d'ID pour votre projet. Un ID client OAuth 2.0 est une chaîne de caractères semblable à ce qui suit :

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

Essayer l'API REST dans OAuth Playground

OAuth Playground est le moyen le plus simple de vous familiariser avec l'API REST Fitness en envoyant des requêtes HTTP et en observant les réponses avant vous n'avez pas à écrire de code client.

Pour autoriser l'API REST Fitness dans OAuth Playground :

  1. Accédez à OAuth Playground.
  2. Sous Étape 1 : Sélectionner et autoriser les API, développez Fitness v1 et sélectionnez les champs d'application Fitness à utiliser.
  3. Cliquez sur le bouton Autoriser les API, puis sélectionnez le projet de la console Google APIs pour utiliser, puis cliquez sur Autoriser lorsque vous y êtes invité. Vous pourrez accéder et modifier les données associées au compte sélectionné dans la console Google APIs.
  4. Cliquez sur le bouton Exchange authorization code for tokens (Échanger le code d'autorisation contre des jetons). Le bac à sable OAuth inclut automatiquement cet en-tête dans l'en-tête de requête Authorization: lorsque vous envoyez des requêtes HTTP. Notez que le jeton d'accès expire au bout de 60 minutes (3 600 secondes).

Envoyer des requêtes HTTP

Les exemples suivants montrent comment envoyer des requêtes HTTP pour lister toutes les sources de données disponibles et en créer une. Pour l'API REST Fitness, le format d'URI est le suivant :

https://www.googleapis.com/fitness/v1/resourcePath?parameters

Pour répertorier toutes les sources de données disponibles:

  1. Dans Méthode HTTP, sélectionnez GET.
  2. Dans le champ URI de la demande, saisissez https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. Cliquez sur Send the request (Envoyer la requête).

La requête et la réponse s'affichent sur le côté droit de la page. Si le si la requête aboutit, la réponse affiche la source de données de la au format JSON.

Pour créer une source de données :

  1. Dans Méthode HTTP, sélectionnez POST.
  2. Dans URI de la requête, saisissez https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. Cliquez sur Indiquez le corps de la requête.

  4. Dans la fenêtre Corps de la requête, copiez et collez le code JSON suivant :

    {
  "dataStreamName": "MyDataSource",
  "type": "derived",
  "application": {
    "detailsUrl": "http://example.com",
    "name": "Foo Example App",
    "version": "1"
  },
  "dataType": {
    "field": [
      {
        "name": "steps",
        "format": "integer"
      }
    ],
    "name": "com.google.step_count.delta"
  },
  "device": {
    "manufacturer": "Example Manufacturer",
    "model": "ExampleTablet",
    "type": "tablet",
    "uid": "1000001",
    "version": "1"
  }
}

  5. Dans la fenêtre Request body (Corps de la requête), cliquez sur Close (Fermer).

  6. Cliquez sur Send the request (Envoyer la requête).

La requête et la réponse s'affichent sur le côté droit de la page. La requête inclut le jeton d'accès OAuth dans l'en-tête Authorization :

Authorization: Bearer ya29.OAuthTokenValue

Si la requête aboutit, la première ligne de la réponse est la suivante:

HTTP/1.1 200 OK

Utiliser cURL pour accéder à l'API REST de Fit

Vous pouvez utiliser l'outil de ligne de commande cURL pour accéder à API REST Fit. Vous aurez besoin d'un jeton d'accès OAuth pour envoyer des requêtes à l'aide de cURL (voir les instructions précédentes). Notez que les jetons d'accès expirent au bout d'une heure. L'exemple suivant montre un script bash simple permettant de lister toutes les sources de données.

#!/bin/bash
ACCESS_TOKEN=""
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://www.googleapis.com/fitness/v1/users/me/dataSources

Étapes suivantes

Pour en savoir plus sur l'API REST, consultez les pages suivantes :