Nhà phát triển · Sự kiện API
REST·JSONtrên HTTP
Sự kiện API.
Đọc các chuyến đi đã ghi điểm, các tuyến đường GPS và bảng phân tích AURA cấp hệ số trên HTTP. Đo từ xa được ghi lại ở rìa bởi SDK và các đầu nối được chứng nhận; API mang đến cho ngăn xếp của bạn kết quả được ghi điểm và có thể giải thích được. AURA hỗ trợ thẩm định bảo hiểm - công ty bảo hiểm được cấp phép giữ quyền định giá.
Bắt đầu nhanh
Xác thực, sau đó đọc điểm.
Mọi yêu cầu đều mang mã thông báo mang và phạm vi nhóm tùy chọn. Phản hồi làJSONvới cờ ok cấp cao nhất.
Xác thực
Chuyển mã thông báo mang vào tiêu đề Ủy quyền. Phạm vi yêu cầu tới một nhóm với tiêu đề x-fleet-id tùy chọn; bỏ qua nó và mã thông báo quản trị sẽ nhìn thấy mọi đội xe mà họ sở hữu.
curl https://api.yas.dev/v1/trips \
-H "Authorization: Bearer $YAS_TOKEN" \
-H "x-fleet-id: fleet_joie"
# Base URL
# Sandbox https://api.sandbox.yas.dev/v1
# Productionhttps://api.yas.dev/v1{
"ok": true,
"trips": [
{ "tripId": "trip_2026_0142", "overallScore": 72.4, "tier": "Good" }
],
"pagination": { "page": 1, "limit": 20, "totalPages": 9, "total": 172 }
}Tài liệu tham khảo
Điểm cuối cốt lõi.
Điểm cuối chỉ đọc cho các chuyến đi, tuyến đường, điểm số và phương tiện. Quá trình nhập diễn ra thông qua SDK và các trình kết nối chứ không phải điểm cuối ghi công khai.
- GET
/v1/tripsList scored trips, newest first, with pagination and fleet scope.
- GET
/v1/trips/{id}Retrieve a single trip with its summary metrics and GPS link.
- GET
/v1/trips/{id}/score-breakdownTheme-by-factor AURA score breakdown for one trip.
- GET
/v1/vehicles/{plate}Vehicle risk profile and driver roster.
Ví dụ
Truy xuất bảng phân tích điểm chuyến đi.
Bảng phân tích nhóm khoảng 100 yếu tố rủi ro thành sáu chủ đề, mỗi chủ đề có điểm phụ riêng và nêu tên chủ đề yếu nhất để bạn biết nên huấn luyện ở đâu.
{
"ok": true,
"breakdown": {
"tripId": "trip_2026_0142",
"overallScore": 72.4,
"mapMatched": true,
"themes": [
{
"id": "speeding", "label": "Speeding",
"themeScore": 68.2,
"factors": [
{ "key": "speedingIntensity", "score": 71.5 }
]
}
],
"weakestTheme": { "id": "speeding", "label": "Speeding" }
}
}Mô hình dữ liệu
Đối tượng Chuyến đi.
Một chuyến đi là đơn vị tính điểm. Đây là những trường mà hầu hết các phần tích hợp đều đọc — lược đồ đầy đủ có trong tài liệu tham khảo.
| trường | Loại | Mô tả |
|---|---|---|
tripId | string | Stable identifier for the trip. |
overallScore | number | AURA score for the trip, 0–100. Higher is safer. |
tier | string | Derived band: Critical (<45), Fair (<65), Good (<80), Safe. |
mapMatched | boolean | Whether the trip was map-matched to the road network. |
distanceKm | number | Trip distance in kilometres. |
durationMin | number | Trip duration in minutes. |
startDate | string | ISO 8601 start timestamp. |
vehicle | string | Vehicle plate or unit identifier. |
Công ước
Có thể dự đoán được bằng thiết kế.
Lỗi
Lỗi trả về ok: false với chuỗi lỗi và trạng tháiHTTPthông thường — 400, 401, 403, 404, 429 hoặc 500.
Phân trang
Liệt kê các điểm cuối lấy trang và giới hạn (10–100) rồi trả về khối phân trang có trang, giới hạn, tổng số trang và tổng số.
phạm vi đội xe
Phạm vi tiêu đề x-fleet-id đọc cho một nhóm. Phạm vi không khớp trả về 404 — không bao giờ là dữ liệu của nhóm khác.
Điểm số
Các bậc được bắt nguồn từ một thang đo: Quan trọng, Khá, Tốt, An toàn — các mức giống nhau trên mọi loại máy.
Tiếp tục xây dựng
Đi đâu tiếp theo.
Xây dựng dựa trên hộp cát.
Các đội đủ điều kiện sẽ nhận được thông tin xác thực hộp cát và tài liệu tham khảo. Hãy cho chúng tôi biết bề mặt và thị trường tích hợp của bạn.
