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

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

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

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

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

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

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

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

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

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

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

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

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

Ниже приведен пример реализации AuthTokenFactory:

class JsonAuthTokenFactory implements AuthTokenFactory {
  private String vehicleServiceToken;  // initially null
  private long expiryTimeMs = 0;
  private String vehicleId;

  // This method is called on a thread whose only responsibility is to send
  // location updates. Blocking is OK, but just know that no location updates
  // can occur until this method returns.
  @Override
  public String getToken(AuthTokenContext authTokenContext) {
    String vehicleId = requireNonNull(context.getVehicleId());

    if (System.currentTimeMillis() > expiryTimeMs || !vehicleId.equals(this.vehicleId)) {
      // The token has expired, go get a new one.
      fetchNewToken(vehicleId);
    }

    return vehicleServiceToken;
  }

  private void fetchNewToken(String vehicleId) {
    String url = "https://yourauthserver.example/token/" + vehicleId;

    try (Reader r = new InputStreamReader(new URL(url).openStream())) {
      com.google.gson.JsonObject obj
          = com.google.gson.JsonParser.parseReader(r).getAsJsonObject();
      vehicleServiceToken = obj.get("VehicleServiceToken").getAsString();
      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 10 minutes from that time.
      expiryTimeMs -= 10 * 60 * 1000;
      this.vehicleId = vehicleId;
    } catch (IOException e) {
      // It's OK to throw exceptions here. The StatusListener you passed to
      // create the DriverContext class will be notified and passed along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}

В этой реализации используется встроенный HTTP-клиент Java, который получает токен в формате JSON от сервера авторизации. Клиент сохраняет токен для повторного использования и запрашивает его заново, если срок действия старого токена истекает в течение 10 минут.

В вашей реализации все может быть по-другому, например для обновления токенов может использоваться фоновый поток.

Доступные клиентские библиотеки для Fleet Engine перечислены в статье Клиентские библиотеки для сервисов поездок по запросу.

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

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