Как получить токены авторизации

Consumer SDK обеспечивает авторизацию с помощью веб-токенов JSON. JSON Web Token (JWT) – это токен авторизации, который предоставляет одну или несколько заявок на сервис.

Consumer SDK использует веб-токен JSON, предоставленный приложением, для связи с Fleet Engine. Подробные сведения о токенах, ожидаемых сервером Fleet Engine, приведены в статьях Веб-токены JSON и Выпуск веб-токенов JSON.

Токен авторизации предоставляет доступ к следующим сервисам Fleet Engine:

  • TripService – предоставляет Consumer SDK доступ к сведениям о поездке, включая местоположение транспортного средства, маршрут и расчетное время прибытия. Токены авторизации для сервиса поездок должны включать утверждение tripid:TRIP_ID в заголовке authorization, где TRIP_ID – это идентификатор поездки по запросу, которой вы делитесь.

  • VehicleService – предоставляет Consumer SDK информацию о приблизительном местоположении транспортного средства, чтобы показывать слой с плотностью транспортных средств и рассчитывать время прибытия в пункт посадки. Поскольку Consumer SDK использует только приблизительное местоположение, токенам авторизации для сервиса транспортных средств не требуется утверждение vehicleid.

Что такое токен?

Для вызовов методов API из сред с низким уровнем доверия (смартфонов и браузеров) Fleet Engine требует использовать веб-токены JSON (JWT).

Токен JWT создается на вашем сервере, подписывается, шифруется и передается клиенту для последующих взаимодействий с сервером, пока не истечет срок его действия или он не станет недействительным.

Основные сведения

Дополнительную информацию о веб-токенах JSON можно найти в разделе Веб-токены JSON статьи Основы Fleet Engine.

Как клиенты получают токены?

После того как водитель или клиент войдет в ваше приложение, используя соответствующие учетные данные авторизации, любые обновления, отправляемые с этого устройства, должны использовать соответствующие токены авторизации, которые сообщают Fleet Engine разрешения для приложения.

Разработчик должен обеспечить в клиентской реализации следующие возможности:

  • Получите веб-токен JSON со своего сервера.
  • Используйте токен повторно, пока не истечет срок его действия, чтобы минимизировать количество обновлений токена.
  • Обновите токен, когда срок его действия истечет.

Класс AuthTokenFactory генерирует токены авторизации при обновлении местоположения. SDK должен упаковать токены с информацией об обновлении, чтобы отправить их в Fleet Engine. Убедитесь, что серверная реализация может выдавать токены до инициализации SDK.

Подробные сведения о токенах, ожидаемых сервисом Fleet Engine, приведены в разделе Выпуск веб-токенов JSON для Fleet Engine.

Пример сборщика токенов авторизации

В примере кода ниже показано, как реализовать обратный вызов токена авторизации.

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

Дальнейшие действия

Инициализация Consumer SDK