Zanim zaczniesz kodować swoją pierwszą aplikację kliencką, musisz wykonać kilka czynności.
Tworzenie projektu dla klienta
Zanim zaczniesz wysyłać żądania, musisz poinformować Google o swoim kliencie i aktywować dostęp do interfejsu API. Możesz to zrobić za pomocą Konsoli interfejsów API Google, aby utworzyć projekt, który jest nazwanym zbiorem ustawień i informacji o dostępie do interfejsu API, oraz zarejestrować aplikację.
Aby zacząć korzystać z interfejsu Android Over The Air API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w Konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.
Umieść projekt na białej liście
Interfejs Android Over The Air API jest dostępny tylko dla projektów z białej listy. Jeśli Twojego projektu nie ma na białej liście, podczas próby jego użycia pojawi się 404 błędów.
Aby dostać się na białą listę, wyślij e-maila do Twojego menedżera Google TAM z prośbą o dodanie do białej listy Twojego nowego identyfikatora projektu.
Identyfikator projektu znajdziesz w panelu Google Cloud. Więcej informacji znajdziesz w tym dokumencie pomocy.
Najlepiej, gdyby identyfikator projektu miał taki format: {company}-gota-api-{number}
Po znalezieniu się na białej liście enable interfejs Android Over The Air API w projekcie i przeczytaj instrukcje dotyczące autoryzacji, aby dowiedzieć się, jak uzyskać dostęp do tego interfejsu.
Pamiętaj, że tylko identyfikator projektu, który podasz, będzie mógł korzystać z interfejsu Android Over The Air API. Zdecydowanie zalecamy, aby do korzystania z interfejsu API utworzyć konto usługi (jak opisano w autoryzacji), a nie konta osobiste.
Wypróbuj panel bezprzewodowy Android
W tej dokumentacji API zakładamy, że zdarzyło Ci się już korzystać z panelu informacyjnego Android Over The Air oraz znać pojęcia związane z programowaniem stron internetowych i formaty danych z sieci.
Jeśli jeszcze nie korzystasz z panelu sterowania Androidem Over The Air, najpierw wypróbuj interfejs w programie.
Poznaj podstawy REST
Interfejs API można wywoływać na 2 sposoby:
- Wysyłanie żądań HTTP i analizowanie odpowiedzi.
- Korzystanie z bibliotek klienta.
Jeśli nie chcesz korzystać z bibliotek klienta, musisz znać podstawy działania REST.
REST to styl architektury oprogramowania zapewniający wygodne i spójne podejście do żądania i modyfikowania danych.
Termin REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google odnosi się do korzystania z czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.
W systemie REST zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer przystąpił do realizacji konkretnego działania (na przykład utworzenia, pobrania, zaktualizowania lub usunięcia zasobu), serwer wykonuje działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.
W interfejsach API Google typu REST klient określa działanie przy użyciu czasownika HTTP, takiego jak POST, GET, PUT czy DELETE. Zasób określa go za pomocą unikalnego identyfikatora URI, który ma postać:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, dlatego REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą sieci.
Definicje metod można znaleźć w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.
REST w interfejsie Android Over The Air API
Operacje interfejsu Android Over The Air API mapują bezpośrednio na czasowniki HTTP REST.
Konkretne formaty identyfikatorów URI w przypadku Android Over The Air API to:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
Podsumowanie pełnych identyfikatorów URI używanych w przypadku każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumencie Android Over The Air API.
Podstawy formatu JSON
Interfejs Android Over The Air API zwraca dane w formacie JSON.
JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który przedstawia proste struktury danych w formie tekstowej. Więcej informacji znajdziesz na stronie json.org.