Korzystanie z interfejsu ARCore API w Google Cloud

Wybierz platformę:

Funkcje ARCore, takie jak Geospatial API i Cloud Anchors, używają interfejsu ARCore API hostowanego w Google Cloud. Podczas korzystania z tych funkcji aplikacja używa danych logowania, aby uzyskać dostęp do usługi ARCore API.

Z tego krótkiego wprowadzenia dowiesz się, jak skonfigurować aplikację, aby komunikować się z usługą interfejsu ARCore API hostowaną w Google Cloud.

Utwórz nowy projekt Google Cloud lub użyj istniejącego projektu

Jeśli masz już projekt, wybierz go.

Otwórz selektor projektów

Jeśli nie masz żadnego projektu Google Cloud, utwórz go.

Utwórz nowy projekt

Włącz interfejs ARCore API

Aby używać interfejsu ARCore API, musisz włączyć go w swoim projekcie.

Włączanie interfejsu ARCore API

Skonfiguruj metodę autoryzacji

Aplikacja na iOS może komunikować się z interfejsem ARCore API za pomocą 2 różnych metod autoryzacji: autoryzacji bez klucza (zalecanej) oraz autoryzacji klucza interfejsu API:

  • Autoryzacja bez klucza wykorzystuje podpisany token do kontrolowania dostępu do interfejsu API. Ta metoda wymaga serwera, który należy do Ciebie, do podpisywania tokenów i kontrolowania dostępu do interfejsu API.
  • Klucz interfejsu API to ciąg znaków identyfikujący projekt Google Cloud. Klucze interfejsu API zwykle nie są uważane za bezpieczne, ponieważ zwykle są dostępne dla klientów. Do komunikacji z interfejsem ARCore API warto użyć autoryzacji tokena.

Bez klucza

ARCore obsługuje autoryzację wywołań interfejsu API w iOS przy użyciu (tokenu internetowego JSON). Token musi być podpisany za pomocą konta usługi Google.

Aby móc generować tokeny dla iOS, musisz mieć na serwerze punkt końcowy, który spełnia te wymagania:

  • Twój własny mechanizm autoryzacji musi chronić punkt końcowy.

  • Punkt końcowy musi za każdym razem wygenerować nowy token, na przykład:

    • Każdy użytkownik otrzymuje unikalny token.
    • Tokeny nie wygasają natychmiast.

Tworzenie konta usługi i klucza podpisywania

Aby utworzyć konto usługi Google i klucz podpisywania, wykonaj te czynności:

  1. W Google Cloud otwórz stronę Dane logowania.
    Dane logowania
  2. Kliknij Utwórz dane logowania > Konto usługi.
  3. W sekcji Szczegóły konta usługi wpisz nazwę nowego konta, a następnie kliknij Utwórz.
  4. Na stronie Uprawnienia konta usługi kliknij menu Wybierz rolę. Wybierz Konta usługi > Twórca tokenów konta usługi i kliknij Dalej.
  5. Na stronie Przyznaj użytkownikom dostęp do tego konta usługi kliknij Gotowe.
  6. Na stronie Dane logowania znajdź sekcję Konta usługi i kliknij nazwę utworzonego właśnie konta.
  7. Na stronie Szczegóły konta usługi przewiń w dół do sekcji Klucze i wybierz Dodaj klucz > Utwórz nowy klucz.
  8. Jako typ klucza wybierz JSON i kliknij Utwórz.

    Spowoduje to pobranie na Twój komputer pliku JSON z kluczem prywatnym. Zapisz pobrany plik klucza JSON w bezpiecznej lokalizacji.

Tworzenie tokenów na serwerze

Aby utworzyć nowe tokeny (JWT) na serwerze, użyj standardowych bibliotek JWT i pliku JSON pobranego bezpiecznie z nowego konta usługi.

Tworzenie tokenów na komputerze programisty

Aby wygenerować tokeny JWT na komputerze programisty, użyj tego polecenia oauth2l:

oauth2l fetch --cache "" --jwt --json $KEYFILE --audience "https://arcore.googleapis.com/"

Określenie pustej lokalizacji pamięci podręcznej za pomocą flagi --cache jest konieczne, aby za każdym razem był generowany inny token. Pamiętaj, aby przyciąć wynikowy ciąg znaków. Dodatkowe spacje lub znaki nowego wiersza spowodują odrzucenie tokena przez interfejs API.

Podpisz token

Aby podpisać token JWT, musisz użyć algorytmu RS256 i następujących deklaracji:

  • iss – adres e-mail konta usługi.
  • sub – adres e-mail konta usługi.
  • iat – czas uniksowego wygenerowania tokena (w sekundach).
  • expiat + 3600 (1 godzina). Czas uniksowego wygaśnięcia tokena (w sekundach).
  • aud – grupa odbiorców. Musi mieć wartość https://arcore.googleapis.com/.

Niestandardowe deklaracje nie są wymagane w ładunku JWT, ale deklaracja uid może być przydatna do identyfikacji odpowiedniego użytkownika.

Jeśli generujesz tokeny JWT w inny sposób, na przykład za pomocą interfejsu Google API w środowisku zarządzanym przez Google, pamiętaj, aby podpisać tokeny JWT za pomocą deklaracji podanych w tej sekcji. Przede wszystkim upewnij się, że odbiorcy mają rację.

Przekaż token w sesji ARCore

  1. Utwórz sesję za pomocą narzędzia GARSession#sessionWithError:.

    NSError *error = nil;
    GARSession *garSession = [GARSession sessionWithError:&error];
    
  2. Gdy uzyskasz token, przekaż go do sesji za pomocą setAuthToken:. W przeciwnym razie sesja użyje najnowszego prawidłowego tokenu autoryzacji przekazanego przez Ciebie. Wywołuj tę metodę po każdym odświeżeniu tokena:

    [garSession setAuthToken: authToken]
    

Twoja aplikacja jest teraz skonfigurowana do korzystania z uwierzytelniania bez klucza.

Przekażąc token do sesji, pamiętaj o tych kwestiach:

  • Jeśli do utworzenia sesji został użyty klucz interfejsu API, ARCore zignoruje token i zgłosi błąd.

    Jeśli nie potrzebujesz już klucza interfejsu API, usuń go w Konsoli Google Developers i usuń go z aplikacji.

  • ARCore ignoruje tokeny zawierające spacje lub znaki specjalne.

  • Tokeny tracą zwykle ważność po godzinie. Jeśli istnieje możliwość, że token wygaśnie podczas użycia, uzyskaj nowy token i przekaż go do interfejsu API.

Klucz interfejsu API

  1. W Google Cloud otwórz stronę Dane logowania.
    Dane logowania
  2. Kliknij Utwórz dane logowania i w menu wybierz Klucz interfejsu API.
    W oknie dialogowym utworzonego klucza interfejsu API pojawi się ciąg nowo utworzonego klucza.
  3. Podczas tworzenia GARSession użyj GARSession#sessionWithAPIKey:bundleIdentifier:error: i wstaw klucz interfejsu API:

    self.garSession = [GARSession sessionWithAPIKey:@"your-api-key"
                                   bundleIdentifier:nil
                                              error:&error];
    
  4. Zapoznaj się z dokumentacją dotyczącą ograniczeń klucza interfejsu API, aby zabezpieczyć swój klucz interfejsu API.

Twoja aplikacja jest teraz skonfigurowana do używania kluczy interfejsu API.

Co dalej

Po skonfigurowaniu autoryzacji sprawdź te funkcje ARCore, które z niej korzystają: