Consumer SDK cung cấp hoạt động uỷ quyền bằng cách sử dụng Mã thông báo Web JSON. Mã thông báo web JSON (JWT) là một mã thông báo uỷ quyền cung cấp một hoặc nhiều thông báo xác nhận quyền sở hữu trên một dịch vụ.
Consumer SDK sử dụng Mã thông báo Web JSON do ứng dụng cung cấp để giao tiếp với Fleet Engine. Để biết thông tin chi tiết về các mã thông báo mà máy chủ Fleet Engine dự kiến, hãy xem phần Mã thông báo web JSON và Phát hành mã thông báo web JSON.
Mã thông báo uỷ quyền cho phép truy cập vào các dịch vụ Fleet Engine sau đây:
TripService
– Cho phép Consumer SDK truy cập vào thông tin chi tiết về chuyến đi, bao gồm cả vị trí xe, tuyến đường và thời gian dự kiến đến. Mã thông báo uỷ quyền cho dịch vụ chuyến đi phải có một yêu cầutripid:TRIP_ID
trong tiêu đềauthorization
của mã thông báo, trong đóTRIP_ID
là mã chuyến đi của chuyến đi theo yêu cầu đang được chia sẻ.VehicleService
– Cung cấp cho Consumer SDK thông tin về vị trí ước chừng của xe để hiển thị lớp mật độ xe và ước tính thời gian dự kiến đến điểm đón. Vì Consumer SDK chỉ sử dụng vị trí ước chừng, nên mã thông báo uỷ quyền cho dịch vụ trên xe không yêu cầu một yêu cầuvehicleid
.
Mã thông báo là gì?
Fleet Engine yêu cầu sử dụng Mã thông báo web JSON (JWT) cho các lệnh gọi phương thức API từ môi trường có độ tin cậy thấp: điện thoại thông minh và trình duyệt.
JWT bắt nguồn từ máy chủ của bạn, được ký, mã hoá và chuyển đến máy khách để tương tác với máy chủ sau đó cho đến khi hết hạn hoặc không còn hợp lệ.
Thông tin chi tiết quan trọng
- Sử dụng Thông tin xác thực mặc định của ứng dụng để xác thực và uỷ quyền đối với Fleet Engine.
- Sử dụng tài khoản dịch vụ phù hợp để ký JWT. Xem các vai trò serviceaccount của Fleet Engine trong phần Kiến thức cơ bản về Fleet Engine.
Để biết thêm thông tin về Mã thông báo web JSON, hãy xem phần Mã thông báo web JSON trong Fleet Engine Essentials.
Làm cách nào để ứng dụng nhận được mã thông báo?
Sau khi người lái xe hoặc người tiêu dùng đăng nhập vào ứng dụng của bạn bằng thông tin uỷ quyền thích hợp, mọi nội dung cập nhật được phát hành từ thiết bị đó phải sử dụng mã thông báo uỷ quyền thích hợp, mã thông báo này sẽ thông báo cho Fleet Engine về các quyền của ứng dụng.
Là nhà phát triển, quá trình triển khai ứng dụng khách của bạn phải có khả năng thực hiện những việc sau:
- Tìm nạp mã thông báo web JSON từ máy chủ của bạn.
- Sử dụng lại mã thông báo cho đến khi mã này hết hạn để giảm thiểu số lần làm mới mã thông báo.
- Làm mới mã thông báo khi mã này hết hạn.
Lớp AuthTokenFactory
tạo mã thông báo uỷ quyền tại thời điểm cập nhật vị trí. SDK phải đóng gói mã thông báo cùng với thông tin cập nhật để gửi đến Fleet Engine. Đảm bảo rằng chế độ triển khai phía máy chủ của bạn có thể phát hành mã thông báo trước khi khởi chạy SDK.
Để biết thông tin chi tiết về các mã thông báo mà dịch vụ Fleet Engine dự kiến, hãy xem phần Phát hành mã thông báo web JSON cho Fleet Engine.
Ví dụ về trình tìm nạp mã uỷ quyền
Ví dụ về mã sau đây minh hoạ cách triển khai một lệnh gọi lại mã thông báo uỷ quyền.
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
}
}
}