Autorisierungstokens abrufen

Das Consumer SDK bietet die Autorisierung mit JSON-Webtokens. Ein JSON Web Token (JWT) ist ein Autorisierungstoken, das eine oder mehrere Anforderungen an einen Dienst enthält.

Das Consumer SDK verwendet das von der Anwendung bereitgestellte JSON-Webtoken für die Kommunikation mit Fleet Engine. Details zu den vom Fleet Engine-Server erwarteten Tokens finden Sie unter JSON-Webtokens und JSON-Webtokens ausstellen.

Das Autorisierungstoken bietet Zugriff auf die folgenden Fleet Engine-Dienste:

  • TripService: Ermöglicht dem Consumer SDK den Zugriff auf Fahrtdetails wie Fahrzeugposition, Route und voraussichtliche Ankunftszeit. Autorisierungstokens für den Fahrdienst müssen eine tripid:TRIP_ID-Anforderung im authorization-Header des Tokens enthalten, wobei TRIP_ID die Fahrt-ID der On-Demand-Fahrt ist, die geteilt wird.

  • VehicleService: Stellt dem Consumer SDK Informationen zum ungefähren Fahrzeugstandort zur Verfügung, damit die Fahrzeugdichteschicht angezeigt und die voraussichtlichen Ankunftszeiten für den Abholort geschätzt werden können. Da im Consumer SDK nur ungefähre Standorte verwendet werden, ist für Autorisierungstokens für den Fahrzeugdienst kein vehicleid-Anspruch erforderlich.

Was ist ein Token?

Für API-Methodenaufrufe aus Umgebungen mit geringem Vertrauensniveau (Smartphones und Browser) ist in Fleet Engine die Verwendung von JSON-Webtokens (JWTs) erforderlich.

Ein JWT wird auf Ihrem Server erstellt, signiert, verschlüsselt und an den Client übergeben. Es wird für nachfolgende Serverinteraktionen verwendet, bis es abläuft oder nicht mehr gültig ist.

Wichtige Details

Weitere Informationen zu JSON Web Tokens finden Sie unter JSON Web Tokens in Fleet Engine Essentials.

Wie erhalten Clients Tokens?

Sobald sich ein Fahrer oder Nutzer mit den entsprechenden Autorisierungsanmeldedaten in Ihrer App anmeldet, müssen für alle von diesem Gerät ausgegebenen Aktualisierungen die entsprechenden Autorisierungstokens verwendet werden, die Fleet Engine die Berechtigungen für die App mitteilen.

Als Entwickler sollte Ihre Clientimplementierung die folgenden Möglichkeiten bieten:

  • Rufen Sie ein JSON-Webtoken von Ihrem Server ab.
  • Verwenden Sie das Token wieder, bis es abläuft, um die Anzahl der Token-Aktualisierungen zu minimieren.
  • Aktualisieren Sie das Token, wenn es abläuft.

Die Klasse AuthTokenFactory generiert Autorisierungstokens zum Zeitpunkt der Standortaktualisierung. Das SDK muss die Tokens mit den Aktualisierungsinformationen verpacken, die an Fleet Engine gesendet werden sollen. Achten Sie darauf, dass Ihre serverseitige Implementierung Tokens ausstellen kann, bevor Sie das SDK initialisieren.

Details zu den vom Fleet Engine-Dienst erwarteten Tokens finden Sie unter JSON-Webtokens für Fleet Engine ausstellen.

Beispiel für einen Abrufer für Autorisierungstokens

Das folgende Codebeispiel zeigt, wie ein Callback für das Autorisierungstoken implementiert wird.

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
    }
  }
}

Nächste Schritte

Consumer SDK initialisieren