SDK dành cho người dùng cung cấp quyền uỷ quyền bằng Mã thông báo web JSON. Mã thông báo web JSON (JWT) là 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ụ.
SDK dành cho người dùng sử dụng Mã thông báo web JSON do ứng dụng cung cấp để giao tiếp với Công cụ của đội xe. Để biết thông tin chi tiết về các mã thông báo mà máy chủ Công cụ của đội xe 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 cấp quyền truy cập vào các dịch vụ sau của Công cụ quản lý đội xe:
TripService– Cấp cho SDK dành cho người dùng quyền 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 đến dự kiến. Mã thông báo uỷ quyền cho dịch vụ chuyến đi phải bao gồm một thông báo xác nhận quyềntripid:TRIP_IDtrong tiêu đềauthorizationcủa mã thông báo, trong đóTRIP_IDlà mã chuyến đi của chuyến đi theo yêu cầu đang được chia sẻ.VehicleService– Cung cấp cho SDK dành cho người dùng 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 đến điểm đón. Vì SDK dành cho người dùng chỉ sử dụng các vị trí gần đúng, nên mã thông báo uỷ quyền cho dịch vụ xe không yêu cầu xác nhận quyềnvehicleid.
Mã thông báo là gì?
Đối với các lệnh gọi phương thức API từ môi trường có mức độ tin cậy thấp, Công cụ của đội xe yêu cầu sử dụng Mã thông báo web JSON (JWT) do một tài khoản dịch vụ thích hợp ký. Môi trường có mức độ tin cậy thấp bao gồm đ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, đây là một môi trường hoàn toàn đáng tin cậy. JWT được ký, mã hoá và chuyển đến ứng dụng cho các lượt tương tác máy chủ tiếp theo cho đến khi hết hạn hoặc không còn hợp lệ.
Phần phụ trợ của bạn phải xác thực và uỷ quyền cho Công cụ của đội xe bằng cách sử dụng cơ chế Thông tin xác thực mặc định của ứng dụng tiêu chuẩn. Hãy nhớ sử dụng JWT do một tài khoản dịch vụ thích hợp ký. Để biết danh sách vai trò của tài khoản dịch vụ, hãy xem các vai trò của tài khoản dịch vụ Fleet Engine trong phần Kiến thức cơ bản về Fleet Engine.
Ngược lại, phần phụ trợ của bạn phải xác thực và uỷ quyền cho Công cụ của đội xe bằng cách sử dụng các cơ chế Thông tin xác thực mặc định của ứng dụng tiêu chuẩn.
Để 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 bài viết Kiến thức cơ bản về công cụ của Fleet.
Ứng dụng nhận mã thông báo bằng cách nào?
Sau khi người lái xe hoặc người dùng đăng nhập vào ứng dụng của bạn bằng thông tin xác thực uỷ quyền thích hợp, mọi bản cập nhật 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 Công cụ quản lý đội xe về các quyền cho ứng dụng.
Là nhà phát triển, quá trình triển khai ứng dụng của bạn phải cung cấp khả năng làm 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ã đó hết hạn để giảm thiểu việc làm mới mã thông báo.
- Làm mới mã thông báo khi mã đó 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 các mã thông báo bằng thông tin cập nhật để gửi đến Công cụ của đội xe. Đảm bảo rằng quá trình triển khai phía máy chủ 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ụ Công cụ của đội xe yêu cầu, hãy xem phần Phát hành mã thông báo web JSON cho Công cụ của đội xe.
Ví dụ về trình tìm nạp mã thông báo uỷ quyền
Mã ví dụ sau đây minh hoạ cách triển khai 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
}
}
}