Uzyskaj tokeny autoryzacji

Pakiet Consumer SDK zapewnia autoryzację za pomocą tokenów internetowych JSON. Token sieciowy JSON (JWT) to token autoryzacji, który zawiera co najmniej 1 roszczenie dotyczące usługi.

Pakiet Consumer SDK 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 sekcjach Tokeny sieciowe JSON i Wystawianie tokenów sieciowych JSON.

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

  • TripService – umożliwia pakietowi Consumer SDK dostęp do szczegółów podróży, w tym pozycji pojazdu, trasy i szacowanego czasu przyjazdu. Tokeny autoryzacji usługi podróży muszą zawierać roszczenie tripid:TRIP_ID w nagłówku authorization tokena, gdzie TRIP_ID to identyfikator podróży na żądanie, która jest udostępniana.

  • VehicleService – przekazuje do pakietu Consumer SDK informacje o przybliżonej lokalizacji pojazdu, aby wyświetlać warstwę gęstości pojazdów i szacować czas dotarcia do punktu odbioru. Pakiet Consumer SDK używa tylko przybliżonych lokalizacji, więc tokeny autoryzacji usługi pojazdu nie wymagają roszczenia vehicleid.

Co to jest token?

Fleet Engine wymaga używania tokenów sieciowych JSON (JWT) w przypadku wywołań metod interfejsu API z środowisk o niskim poziomie zaufania: smartfonów i przeglądarek.

Token JWT pochodzi z Twojego serwera, jest podpisany i zaszyfrowany, a następnie przekazywany do klienta w celu dalszych interakcji z serwerem, dopóki nie wygaśnie lub nie będzie już ważny.

Najważniejsze informacje

Więcej informacji o tokenach sieciowych JSON znajdziesz w sekcji Tokeny sieciowe JSON w podstawowych informacjach o Fleet Engine.

Jak klienci otrzymują tokeny?

Gdy kierowca lub konsument zaloguje się w aplikacji za pomocą odpowiednich danych logowania, wszystkie aktualizacje wysyłane z tego urządzenia muszą używać odpowiednich tokenów autoryzacji, które informują Fleet Engine o uprawnieniach aplikacji.

Jako deweloper musisz zapewnić w implementacji klienta możliwość wykonania tych czynności:

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

Klasa AuthTokenFactory generuje tokeny autoryzacji w momencie 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 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
    }
  }
}

Co dalej?

Inicjowanie pakietu SDK dla konsumentów