Avant de commencer à coder votre première application cliente, vous devez suivre quelques étapes (si ce n'est déjà fait).
Obtenir un compte Google
Vous devez disposer d'un compte Google pour créer un projet dans la console Google APIs. Si vous avez déjà un compte, vous êtes prêt.
Vous pouvez également créer un compte Google distinct à des fins de test.
Créer un projet pour votre client
Avant de pouvoir envoyer des requêtes à l'API Google Knowledge Graph Search, vous devez fournir à Google des informations sur votre client et activer l'accès à l'API. Pour ce faire, utilisez la console Google APIs afin de créer un projet (collection spécifique de paramètres et d'informations d'accès à l'API), puis enregistrez votre application.
Pour commencer à utiliser l'API Google Knowledge Graph Search, vous devez d'abord utiliser l'outil de configuration, qui vous aide à créer un projet dans la console Google APIs, à activer l'API et à créer des identifiants.
Si vous ne l'avez pas déjà fait, créez la clé API de votre application en cliquant sur Créer des identifiants > Clé API. Recherchez ensuite votre clé API dans la section Clés API.
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. Elle spécifie une ressource par un URI 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 Google Knowledge Graph Search
Les opérations de l'API Search de Google Knowledge Graph correspondent directement aux verbes HTTP REST.
Les formats spécifiques des URI de l'API Google Knowledge Graph Search sont les suivants:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
L'ensemble complet des URI utilisés pour chaque opération disponible dans l'API est récapitulé dans la documentation de référence de l'API Google Knowledge Graph Search.
Apprendre les bases du format JSON
L'API Google Knowledge Graph Search 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.