Pakiet SDK dla konsumenta zapewnia autoryzację za pomocą tokenów sieciowych JSON. Token internetowy JSON (JWT) to token autoryzacji służący do tworzenia co najmniej 1 żądania usługi.
Pakiet konsumencki SDK używa tokena internetowego JSON udostępnionego przez aplikację do komunikacji z Fleet Engine. Szczegółowe informacje o tokenach oczekiwanych przez serwer Fleet Engine znajdziesz w sekcjach Tokeny sieciowe JSON i Wydawanie tokenów sieciowych JSON.
Token autoryzacji zapewnia dostęp do tych usług Fleet Engine:
TripService– przyznaje pakietowi Consumer SDK dostęp do szczegółów przejazdu, w tym do pozycji pojazdu, trasy i szacowanego czasu przybycia. Tokeny autoryzacji usługi podróży muszą zawierać w główceauthorizationtokena zapytanietripid:TRIP_ID, gdzieTRIP_IDto identyfikator podróży na żądanie, która jest udostępniana.VehicleService– przekazuje pakietowi SDK dla konsumentów informacje o przybliżonej lokalizacji pojazdu na potrzeby wyświetlania warstwy gęstości pojazdu i szacowania czasu dotarcia na miejsce. Pakiet SDK dla konsumentów używa tylko przybliżonych lokalizacji, więc tokeny autoryzacji dla usługi dotyczącej pojazdu nie wymagają oświadczeniavehicleid.
Co to jest token?
W przypadku wywołań metod interfejsu API z środowisk o niskim poziomie zaufania usługa Fleet Engine wymaga korzystania z tokenów sieciowych JSON (JWT) podpisanych odpowiednim kontem usługi. Środowiska o niskim stopniu zaufania to m.in. smartfony i przeglądarki. Token JWT pochodzi z serwera, który jest pełnowymiarowym zaufanym środowiskiem. JWT jest podpisywany, szyfrowany i przekazywany do klienta na potrzeby kolejnych interakcji z serwerem, dopóki nie wygaśnie lub nie straci ważności.
Backend powinien uwierzytelniać i autoryzować się w Fleet Engine za pomocą standardowych mechanizmów domyślnych danych logowania aplikacji. Pamiętaj, aby używać tokenów JWT, które zostały podpisane przez odpowiednie konto usługi. Listę ról kont usług znajdziesz w artykule Podstawy Fleet Engine, w sekcji Role kont usług Fleet Engine.
Z kolei backend powinien uwierzytelniać i autoryzować się w ramach Fleet Engine, korzystając ze standardowych mechanizmów danych uwierzytelniających aplikacji.
Więcej informacji o tokenach sieciowych JSON znajdziesz w artykule o tokenach sieciowych JSON w artykule na temat Fleet Engine Essentials.
W jaki sposób klienci otrzymują tokeny?
Gdy sterownik lub klient zaloguje się w Twojej aplikacji przy użyciu odpowiednich danych uwierzytelniających, wszystkie aktualizacje wprowadzane z tego urządzenia muszą korzystać z odpowiednich tokenów autoryzacji, które komunikują się z Fleet Engine o uprawnieniach aplikacji.
Jako deweloper powinieneś zadbać o to, aby implementacja klienta umożliwiała:
- Pobierz token sieciowy JSON z serwera.
- Aby zminimalizować częstotliwość odświeżania tokenów, używaj tokena do momentu jego wygaśnięcia.
- Odśwież token po jego wygaśnięciu.
Klasa AuthTokenFactory generuje tokeny autoryzacji w czasie aktualizacji lokalizacji. Pakiet SDK musi zawierać tokeny z informacjami o aktualizacji, które mają zostać wysłane do Fleet Engine. Przed zainicjowaniem pakietu SDK upewnij się, że implementacja po stronie serwera może wysyłać tokeny.
Szczegółowe informacje o tokenach wymaganych przez usługę Fleet Engine znajdziesz w artykule Wydawanie tokenów sieciowych JSON na temat Fleet Engine.
Przykład pobierania tokena autoryzacji
Poniższy przykład kodu pokazuje, jak zaimplementować wywołanie zwrotne tokena autoryzacji.
Java
class JsonAuthTokenFactory implements AuthTokenFactory {
private static final String TOKEN_URL =
"https://yourauthserver.example/token";
private static class CachedToken {
String tokenValue;
long expiryTimeMs;
String tripId;
}
private CachedToken token;
/*
* This method is called on a background thread. Blocking is OK. However, be
* aware that no information can be obtained from Fleet Engine until this
* method returns.
*/
@Override
public String getToken(AuthTokenContext context) {
// If there is no existing token or token has expired, go get a new one.
String tripId = context.getTripId();
if (tripId == null) {
throw new RuntimeException("Trip ID is missing from AuthTokenContext");
}
if (token == null || System.currentTimeMillis() > token.expiryTimeMs ||
!tripId.equals(token.tripId)) {
token = fetchNewToken(tripId);
}
return token.tokenValue;
}
private static CachedToken fetchNewToken(String tripId) {
String url = TOKEN_URL + "/" + tripId;
CachedToken token = new CachedToken();
try (Reader r = new InputStreamReader(new URL(url).openStream())) {
com.google.gson.JsonObject obj
= com.google.gson.JsonParser.parseReader(r).getAsJsonObject();
token.tokenValue = obj.get("ServiceToken").getAsString();
token.expiryTimeMs = obj.get("TokenExpiryMs").getAsLong();
/*
* The expiry time could be an hour from now, but just to try and avoid
* passing expired tokens, we subtract 5 minutes from that time.
*/
token.expiryTimeMs -= 5 * 60 * 1000;
} catch (IOException e) {
/*
* It's OK to throw exceptions here. The error listeners will receive the
* error thrown here.
*/
throw new RuntimeException("Could not get auth token", e);
}
token.tripId = tripId;
return token;
}
}
Kotlin
class JsonAuthTokenFactory : AuthTokenFactory() {
private var token: CachedToken? = null
/*
* This method is called on a background thread. Blocking is OK. However, be
* aware that no information can be obtained from Fleet Engine until this
* method returns.
*/
override fun getToken(context: AuthTokenContext): String {
// If there is no existing token or token has expired, go get a new one.
val tripId =
context.getTripId() ?:
throw RuntimeException("Trip ID is missing from AuthTokenContext")
if (token == null || System.currentTimeMillis() > token.expiryTimeMs ||
tripId != token.tripId) {
token = fetchNewToken(tripId)
}
return token.tokenValue
}
class CachedToken(
var tokenValue: String? = "",
var expiryTimeMs: Long = 0,
var tripId: String? = "",
)
private companion object {
const val TOKEN_URL = "https://yourauthserver.example/token"
fun fetchNewToken(tripId: String) {
val url = "$TOKEN_URL/$tripId"
val token = CachedToken()
try {
val reader = InputStreamReader(URL(url).openStream())
reader.use {
val obj = com.google.gson.JsonParser.parseReader(r).getAsJsonObject()
token.tokenValue = obj.get("ServiceToken").getAsString()
token.expiryTimeMs = obj.get("TokenExpiryMs").getAsLong()
/*
* The expiry time could be an hour from now, but just to try and avoid
* passing expired tokens, we subtract 5 minutes from that time.
*/
token.expiryTimeMs -= 5 * 60 * 1000
}
} catch (e: IOException) {
/*
* It's OK to throw exceptions here. The error listeners will receive the
* error thrown here.
*/
throw RuntimeException("Could not get auth token", e)
}
token.tripId = tripId
return token
}
}
}