Las operaciones de la API de Administrador se mapean directamente a los verbos HTTP de REST, lo que significa que usas métodos HTTP estándar para recuperar y manipular los recursos.
Los formatos específicos para los URI de la API de Administrador son los siguientes:
https://appengine.googleapis.com/v1/resourcePath?parameters
Por ejemplo, para enumerar todos los detalles sobre la versión my-v1 en el servicio my-
frontend de la aplicación en el proyecto my-app, puedes enviar la solicitud HTTP con el parámetro ?view=FULL:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Consulta el documento de referencia de la API de App Engine Admin a fin de ver el conjunto completo de URI usados para cada operación compatible en la API.
Aprende los conceptos básicos
¿No estás familiarizado con las API de REST? A continuación, te presentamos algunos recursos para comenzar.
Conceptos básicos de REST
Existen dos maneras de invocar la API:
- Enviar solicitudes HTTP y analizar las respuestas
- Usa bibliotecas cliente
Si decides no usar bibliotecas cliente, deberás comprender los conceptos básicos de REST.
REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.
El término REST es la abreviatura de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las API de Google, se refiere al uso de los verbos HTTP para recuperar y modificar las representaciones de los datos almacenados por Google.
En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.
En las API con tecnología REST de Google, el cliente especifica una acción con un verbo HTTP como POST, GET, PUT o DELETE. Especifica un recurso mediante un URI único a nivel global de la siguiente manera:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.
Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET, POST, PUT y DELETE.
Conceptos básicos de JSON
La API de Administrador muestra datos en formato JSON.
JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.