Les opérations de l'API Admin sont directement mappées aux verbes HTTP REST, ce qui signifie que vous utilisez des méthodes HTTP standards pour récupérer et manipuler vos ressources.
Les formats spécifiques des URI de l'API Admin sont les suivants :
https://appengine.googleapis.com/v1/resourcePath?parameters
Par exemple, pour répertorier tous les détails de la version my-v1 dans le service my-
frontend de l'application dans le projet my-app, vous pouvez envoyer la requête HTTP avec le paramètre ?view=FULL :
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Consultez la documentation de référence de l'API App Engine Admin pour obtenir l'ensemble complet des URI utilisés pour chaque opération compatible avec l'API.
Suivez notre tour d'horizon des fonctionnalités.
Vous débutez sur les API REST ? Voici quelques ressources utiles pour vous aider à vous lancer.
Principes de base de REST
Il existe deux façons d'appeler l'API :
- Envoi de requêtes HTTP et analyse des réponses
- Utiliser les bibliothèques clientes
Si vous décidez de ne pas utiliser de bibliothèques clientes, vous devez comprendre les bases de l'architecture REST.
Il s'agit d'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 comme POST, GET, PUT ou DELETE. La ressource est désignée 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.
Principes de base de JSON
L'API Admin 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.