Antes de que comiences a escribir el código de tu primera aplicación cliente, hay unas cuantas tareas que debes realizar si aún no las has hecho.
Crea un proyecto para tu cliente
Antes de poder enviar solicitudes, debes informar a Google sobre tu cliente y activar el acceso a la API. Esto lo haces usando la Consola de APIs de Google para crear un proyecto, que es una colección con nombre de configuración y la información de acceso a la API, y registra tu aplicación.
Para comenzar a usar la API de Android Over The Air, primero debes hacer lo siguiente: uso la herramienta de configuración, que te guiará para crear un proyecto en el Consola de APIs de Google, cómo habilitar la API y crear credenciales.
Incluir el proyecto en la lista de entidades permitidas
La API de Android Over The Air solo está disponible para proyectos incluidos en la lista de entidades permitidas. Si tu proyecto no está incluido en la lista blanca,
recibirás 404
errores cuando intentes usarlo.
Para que se te incluya en la lista blanca, envía un correo electrónico a tu TAM de Google para que incluya tu nuevo ID del proyecto en la lista de entidades permitidas.
Puedes encontrar el ID del proyecto en el panel de Cloud. Consulta este documento de ayuda para obtener más información.
Ten en cuenta que el ID del proyecto idealmente debe tener el siguiente formato: {company}-gota-api-{número}
Una vez que se te haya incluido en la lista blanca, habilita la API de Android Over The Air para tu proyecto y consulta el instructivo sobre la autorización para obtener detalles sobre el acceso a ella.
Ten en cuenta que solo el ID del proyecto que proporcionaste podrá usar la API de Android Over The Air. Mié se recomienda crear una cuenta de servicio (como se describe en la autorización) para el uso de la API en lugar de usar cuentas personales.
Prueba el panel inalámbrico de Android
Esta documentación de la API supone que has utilizado el panel de Android Over The Air y que estás familiarizado con los conceptos de programación web y los formatos de datos web.
Si no has usado el panel de control inalámbrico de Android, prueba la interfaz de usuario antes de comenzar a programar.
Obtén información sobre los aspectos básicos de REST
Existen dos maneras de invocar la API:
- Enviar solicitudes HTTP y analizar las respuestas
- Usar bibliotecas cliente
Si decides no usar bibliotecas cliente, deberás comprender los aspectos 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
.
REST en la API inalámbrica de Android
Las operaciones de la API de Android Over The Air se asignan directamente a los verbos HTTP de REST.
Los formatos específicos para los URI de la API de Android Over The Air son los siguientes:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
El conjunto completo de URI que se usa para cada operación compatible con la API se resume en el documento Referencia de la API de Android Over The Air.
Obtén información sobre los aspectos básicos de JSON
La API de Android Over The Air 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.