Pré-requisitos

Antes de começar a codificar seu primeiro aplicativo cliente, há algumas coisas que você precisa fazer, se ainda não tiver feito.

Criar um projeto para o cliente

Antes de enviar solicitações, informe ao Google sobre seu cliente e ative o acesso à API. Para isso, use o Console de APIs do Google para criar um projeto, que é uma coleção nomeada de configurações e informações de acesso à API, e registrar seu aplicativo.

Para começar a usar a API Over The Air do Android, primeiro use a ferramenta de configuração, que orienta você na criação de um projeto no Console de APIs do Google, na ativação da API e na criação de credenciais.

Autorizar o projeto

A API Android Over The Air só está disponível para projetos na lista de permissões. Se o projeto não estiver na lista de permissões, você receberá erros 404 ao tentar usá-lo.

Para entrar na lista de permissões, envie um e-mail ao TAM do Google para que o novo ID do projeto seja incluído na lista de permissões.

O ID do projeto pode ser encontrado no painel do Cloud. Consulte este documento de ajuda para saber mais.

O ID do projeto deve ter o seguinte formato: {company}-gota-api-{number}

Depois de entrar na lista de permissões, enable a API Android Over The Air no seu projeto e confira as instruções de autorização para saber como acessá-la.

Apenas o ID do projeto que você forneceu poderá usar a API Android Over The Air. Recomendamos a criação de uma conta de serviço (como descrito na autorização) para uso da API em vez de contas pessoais.

Teste o painel do Android Over the Air

Esta documentação da API presume que você usou o Painel de controle do Android Over The Air e que está familiarizado com conceitos de programação e formatos de dados da Web.

Se você nunca usou o painel do Android Over The Air, teste a interface do usuário antes de começar a programar.

Conhecer os fundamentos de REST

Há duas maneiras de invocar a API:

Se você não quer usar as bibliotecas de cliente, precisa entender os fundamentos da REST.

O REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.

O termo REST é a sigla de "Representational State Transfer". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.

Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.

Nas APIs RESTful do Google, o cliente especifica uma ação usando um verbo HTTP, como POST, GET, PUT ou DELETE. Ele especifica um recurso por um URI globalmente exclusivo da seguinte forma:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.

As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.

REST na API Android Over The Air

As operações da API Android Over The Air são mapeadas diretamente para os verbos HTTP REST.

Os formatos específicos para URIs da API Android Over The Air são:

https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters

O conjunto completo de URIs usados para cada operação compatível na API é resumido no documento Referência da API Android Over The Air.

Conhecer os fundamentos do JSON

A API Android Over The Air retorna dados no formato JSON.

JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).