Avant de commencer à coder votre première application cliente, vous devez suivre quelques étapes (si ce n'est déjà fait).
Créer un projet pour votre client
Avant de pouvoir envoyer des requêtes, vous devez fournir des informations sur votre client à Google et activer l'accès à l'API. Pour ce faire, vous devez utiliser la console Google APIs pour créer un projet, c'est-à-dire une collection nommée de paramètres et d'informations d'accès à l'API, puis enregistrer votre application.
Pour commencer à utiliser l'API Android Over The Air, vous devez d'abord utiliser l'outil de configuration, qui vous guide tout au long de la création d'un projet dans la console Google APIs, de l'activation de l'API et de la création d'identifiants.
Ajouter le projet à la liste blanche
L'API Android Over The Air n'est disponible que pour les projets sur liste blanche. Si votre projet ne figure pas sur la liste blanche, vous recevrez des erreurs 404 lorsque vous tenterez de l'utiliser.
Pour être ajouté à la liste blanche, envoyez un e-mail à votre TAM Google afin qu'il ajoute votre nouvel ID de projet à la liste blanche.
L'ID du projet est disponible dans votre tableau de bord Cloud. Pour en savoir plus, consultez cette documentation d'aide.
Notez que l'ID du projet doit idéalement être au format {company}-gota-api-{numéro}
Une fois que vous avez été ajouté à la liste blanche, enable l'API Android Over The Air pour votre projet et consultez la procédure d'autorisation pour savoir comment y accéder.
Notez que seul l'ID de projet que vous avez fourni pourra utiliser l'API Android Over The Air. Nous vous recommandons vivement de créer un compte de service (comme décrit dans la section "Autorisation") pour l'utilisation de l'API plutôt que d'utiliser des comptes personnels.
Essayer le tableau de bord Android Over The Air
Cette documentation de l'API suppose que vous avez utilisé le tableau de bord Android Over The Air, et que vous connaissez les concepts de programmation Web et les formats de données Web.
Si vous n'avez pas encore utilisé le tableau de bord Android Over The Air, essayez l'interface utilisateur avant de commencer à coder.
Apprendre les bases de l'architecture REST
Il existe deux façons d'appeler l'API :
- Envoi de requêtes HTTP et analyse des réponses
- Utilisation de bibliothèques clientes
Si vous décidez de ne pas utiliser de bibliothèques clientes, vous devez comprendre les bases de l'architecture REST.
REST est un style d'architecture logicielle qui permet de demander et modifier des données de manière pratique et cohérente.
Le terme REST est l'acronyme de Representational State Transfer. Dans le contexte des API Google, il désigne l'utilisation de verbes HTTP pour extraire et modifier des représentations de données stockées par Google.
Dans un système RESTful, les ressources sont stockées dans un datastore. Un client envoie une requête pour que le serveur exécute une action spécifique (par exemple la création, l'extraction, la mise à jour ou la suppression d'une ressource), et le serveur exécute l'action et envoie une réponse, souvent sous la forme d'une représentation de la ressource spécifiée.
Dans les API RESTful de Google, le client spécifie une action à l'aide d'un verbe HTTP tel que POST, GET, PUT ou DELETE. Il spécifie une ressource avec un URI global unique au format suivant:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Étant donné que toutes les ressources d'API possèdent des URI uniques accessibles via HTTP, REST permet la mise en cache des données, et son fonctionnement est optimisé pour l'infrastructure distribuée du Web.
Les définitions de méthode figurant dans la documentation du standard HTTP 1.1 peuvent s'avérer utiles, car elles incluent les spécifications pour GET, POST, PUT, et DELETE.
REST dans l'API Android Over The Air
Les opérations de l'API Android Over The Air sont directement mappées aux verbes HTTP REST.
Les formats spécifiques des URI de l'API Android Over The Air sont les suivants:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
L'ensemble complet des URI utilisés pour chaque opération disponible dans l'API est résumé dans la documentation de référence de l'API Android Over The Air.
Apprendre les bases du format JSON
L'API Android Over The Air renvoie les données au format JSON.
JSON (JavaScript Object Notation) est un format de données qui ne dépend pas d'un langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.