Прежде чем вы сможете приступить к написанию своего первого клиентского приложения, вам необходимо сделать несколько вещей, если вы еще этого не сделали.
Создайте проект для своего клиента
Прежде чем вы сможете отправлять запросы, вам необходимо сообщить Google о своем клиенте и активировать доступ к API. Вы делаете это с помощью консоли Google API, чтобы создать проект , который представляет собой именованную коллекцию настроек и информации о доступе к API, и зарегистрировать свое приложение.
Чтобы начать использовать Android Over The Air API, вам необходимо сначала использовать инструмент настройки , который поможет вам создать проект в консоли Google API, включить API и создать учетные данные.
Добавьте проект в белый список
Android Over The Air API доступен только для проектов, внесенных в белый список. Если ваш проект не внесен в белый список, при попытке его использования вы получите ошибку 404 .
Чтобы попасть в белый список, отправьте электронное письмо на свой TAM Google, чтобы внести в белый список свой новый идентификатор проекта .
Идентификатор проекта можно найти на панели управления Cloud . Дополнительную информацию см. в этом справочном документе .
Обратите внимание, что идентификатор проекта в идеале должен иметь следующий формат: {company}-gota-api-{номер}.
После того, как вы были внесены в белый список, включите Android Over The Air API для своего проекта и ознакомьтесь с инструкциями по авторизации для получения подробной информации о доступе к нему.
Обратите внимание, что только предоставленный вами идентификатор проекта сможет использовать Android Over The Air API. Мы настоятельно рекомендуем создать сервисную учетную запись (как описано в разделе авторизация) для использования API, а не использовать какие-либо личные учетные записи.
Попробуйте Android Over The Air Dashboard
В этой документации по API предполагается, что вы использовали Android Over The Air Dashboard и знакомы с концепциями веб-программирования и форматами веб-данных.
Если вы еще не использовали Android Over The Air Dashboard, опробуйте пользовательский интерфейс, прежде чем приступать к написанию кода.
Изучите основы REST
Есть два способа вызвать API:
- Отправка HTTP-запросов и анализ ответов.
- Использование клиентских библиотек .
Если вы решите не использовать клиентские библиотеки, вам необходимо понять основы REST.
REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.
Термин REST является сокращением от « Передача представительского состояния ». В контексте API Google это относится к использованию команд HTTP для получения и изменения представлений данных, хранящихся в Google.
В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос на то, чтобы сервер выполнил определенное действие (например, создание, получение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.
В API-интерфейсах RESTful Google клиент указывает действие с помощью команды HTTP, такой как POST , GET , PUT или DELETE . Он определяет ресурс с помощью глобально уникального URI следующей формы:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Поскольку все ресурсы API имеют уникальные URI, доступные по HTTP, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной инфраструктурой Интернета.
Определения методов в документации по стандартам HTTP 1.1 могут оказаться полезными; они включают спецификации для GET , POST , PUT и DELETE .
REST в Android Over The Air API
Операции Android Over The Air API напрямую сопоставляются с HTTP-глаголами REST.
Конкретные форматы URI Android Over The Air API:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
Полный набор URI, используемых для каждой поддерживаемой операции в API, приведен в справочном документе Android Over The Air API .
Изучите основы JSON
Android Over The Air API возвращает данные в формате JSON.
JSON (нотация объектов JavaScript) — это распространенный, независимый от языка формат данных, который обеспечивает простое текстовое представление произвольных структур данных. Для получения дополнительной информации посетите json.org .