Uzyskaj tokeny autoryzacji

Pakiet SDK dla konsumenta zapewnia autoryzację za pomocą tokenów internetowych JSON. Token internetowy JSON (JWT) to token autoryzacji, który zapewnia co najmniej 1 roszczenie do usługi.

Pakiet SDK dla klientów używa tokena internetowego JSON dostarczonego przez aplikację do komunikacji z Fleet Engine. Szczegółowe informacje o tokenach oczekiwanych przez serwer Fleet Engine znajdziesz w artykułach Tokeny sieciowe JSON i Wydawanie tokenów sieciowych JSON.

Token autoryzacji zapewnia dostęp do tych usług Fleet Engine:

  • TripService – daje pakietowi SDK klienta dostęp do szczegółów przejazdu, w tym do pozycji pojazdu, trasy i szacowanego czasu dotarcia na miejsce. Tokeny autoryzacji dla usługi przejazdów muszą zawierać deklarację tripid:TRIP_ID w nagłówku authorization tokena, gdzie TRIP_ID to identyfikator udostępnianego przejazdu na żądanie.

  • VehicleService – przekazuje pakietowi SDK dla klientów informacje o przybliżonej lokalizacji pojazdu, aby wyświetlić warstwę gęstości pojazdów i oszacować czas dotarcia do punktu odbioru. Pakiet SDK dla konsumenta używa tylko przybliżonych lokalizacji, dlatego tokeny autoryzacji usługi pojazdu nie wymagają deklaracji vehicleid.

Czym jest token?

Fleet Engine wymaga używania tokenów internetowych JSON (JWT) do wywoływania metod interfejsu API ze środowisk o niskim poziomie zaufania: smartfonów i przeglądarek.

Token JWT pochodzi z Twojego serwera, jest podpisany, zaszyfrowany i przekazywany do klienta na potrzeby kolejnych interakcji z serwerem, dopóki nie wygaśnie lub nie straci ważności.

Najważniejsze informacje

Więcej informacji o tokenach sieciowych JSON znajdziesz w sekcji Tokeny sieciowe JSON w artykule Podstawowe informacje o Fleet Engine.

Jak klienci otrzymują tokeny?

Gdy kierowca lub klient zaloguje się w aplikacji za pomocą odpowiednich danych uwierzytelniających, wszystkie aktualizacje wysyłane z tego urządzenia muszą używać odpowiednich tokenów autoryzacji, które przekazują do Fleet Engine uprawnienia aplikacji.

Jako deweloper musisz zapewnić w implementacji klienta możliwość:

  • Pobierz token sieciowy JSON z serwera.
  • Używaj tokena, dopóki nie wygaśnie, aby zminimalizować liczbę odświeżeń tokena.
  • Odśwież token, gdy wygaśnie.

Klasa AuthTokenFactory generuje tokeny autoryzacji podczas aktualizacji lokalizacji. Pakiet SDK musi spakować tokeny z informacjami o aktualizacji, aby wysłać je do Fleet Engine. Zanim zainicjujesz pakiet SDK, upewnij się, że implementacja po stronie serwera może wydawać tokeny.

Szczegółowe informacje o tokenach oczekiwanych przez usługę Fleet Engine znajdziesz w artykule Wystawianie tokenów sieciowych JSON dla Fleet Engine.

Przykład modułu pobierającego token autoryzacji

Poniższy przykładowy kod 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
    }
  }
}

Co dalej?

Inicjowanie pakietu SDK dla konsumentów