Premiers pas avec l'API REST

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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

Pour utiliser l'API REST Fitness, vous devez comprendre les principes de base des services Web RESTful et des représentations JSON.

Obtenir un compte Google

Pour utiliser l'API REST Fitness, vous avez besoin 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 pour demander un ID client OAuth 2.0 pour l'API Fitness.

  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 dont les requêtes proviennent (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 traité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 code secret OAuth 2.0 apparaît dans la liste des ID de votre projet. Un ID client OAuth 2.0 est une chaîne de caractères semblable à celle-ci:

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

Essayer l'API REST dans OAuth Playground

OAuth Playground est le moyen le plus simple de se familiariser avec l'API Fitness REST en envoyant des requêtes HTTP et en observant les réponses avant d'écrire un 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 habilitations de remise en forme à utiliser.
  3. Cliquez sur le bouton Authorize APIs (Autoriser les API), sélectionnez le projet de la console Google APIs à utiliser, puis cliquez sur Allow (Autoriser) lorsque vous y êtes invité. Vous pouvez accéder aux données associées au compte sélectionné dans la console Google APIs et les modifier.
  4. Cliquez sur le bouton Exchange authorization code for tokens (Échanger le code d'autorisation contre des jetons). Le terrain de jeu 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 répertorier toutes les sources de données disponibles et créer une source de données. 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 Request URI (URI de la requête), saisissez https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. Cliquez sur Envoyer la requête.

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

Pour créer une source de données :

  1. Dans Méthode HTTP, sélectionnez PUBLIER.
  2. Dans le champ Request URI (URI de la requête), saisissez https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. Cliquez sur Saisir le corps de la requête.
  4. Dans la fenêtre Request Body (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 Envoyer la requête.

La demande 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:

HTTP/1.1 200 OK

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

Vous pouvez utiliser l'outil de ligne de commande cURL pour accéder à l'API REST Fit. Vous avez 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: