Premiers pas avec l'API REST

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

Pour utiliser l'API REST Fitness, vous devez comprendre les principes de base Services Web RESTful et les 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. Utiliser le même projet pour Android et REST de votre application.
  3. Cliquez sur Continuer pour activer Fitness API.
  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 sur lequel les réponses sera traitée (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 code 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, quelque chose comme ceci:

    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électionnez et autoriser les API, développez Fitness v1, puis sélectionnez les champs d'application de forme à 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 protocole OAuth Playground inclut automatiquement cet en-tête dans 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 sources de données disponibles et créer une nouvelle source de données. Pour l'API REST Fitness dans l'API, le format de l'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 demande et la réponse s'affichent sur le côté droit de la page. Si le si la requête a abouti, la réponse affiche la source de données de la précédente au format JSON.

Pour créer une source de données:

  1. Dans Méthode HTTP, sélectionnez POST.
  2. Dans le champ URI de la demande, 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 Send the request (Envoyer la requête).

La demande et la réponse s'affichent sur le côté droit de la page. La demande 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 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 simple script bash pour 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: