跳到內容

設定

setup 保存這部手機的身分。它不會開始記錄。

例子使用 partner 與 https://api.example.yas。

欄位 必須 傳送
partnerId 是 YAS 發給該合作夥伴的 id
apiBaseUrl 是 帶 host 的絕對 https URL。其他值會拒絕 setup。
driverId 是 這部手機上的司機
vehicleId 是 這一更的車輛
consentVersion 否 司機已接受的私隱通知版本。由 App 出示該通知。

tokenProvider 是另一個參數。它交回 accessToken 與 expiresAt,或失敗。SDK 在主執行緒以外呼叫它。不要彈出介面,因為背景也會呼叫。為這次 setup 的 partnerId、driverId 與 vehicleId 取 token。見 身份驗證。

每次重新開啟 App,在知道司機之後呼叫 setup,包括系統重新開啟 App。以同一司機和車輛再呼叫 setup,會換上新的 tokenProvider。openTripId 有值時,換成另一位司機或另一輛車會被拒絕。先為該行程呼叫 endTrip。

在這次程序尚未呼叫 registerAtLaunch 之前呼叫 setup 會被拒絕。空的 partnerId、driverId 或 vehicleId 會被拒絕。必須提供 metadata,而且不能是空的。不是 JSON 的值同樣被拒絕。被拒絕的 setup 不會改動 state、openTripId,以及上一次成功的 setup。沒有呼叫會 throw。

partnerMetadata 是與該合作夥伴約定的內容。欄位不列在這裡。

import YasCapture
func driverAndVehicleKnown(
driverId: String,
vehicleId: String,
partnerMetadata: [String: Any]
) {
YasCapture.shared.setup(
YasConfig(
partnerId: "partner",
apiBaseUrl: "https://api.example.yas",
driverId: driverId,
vehicleId: vehicleId,
consentVersion: "2026-09-01"
),
metadata: partnerMetadata,
tokenProvider: { completion in
// completion(accessToken, expiresAt)
// completion(nil, nil) on failure.
}
)
}

必須提供。欄位名稱按合作夥伴約定。服務照原樣保存。這份參考不列這些欄位。

值必須是 JSON:字串、布林、數字、null,或巢狀 object 或 list。Swift Date 或 Kotlin Instant 可以接受,並以 ISO-8601 UTC 字串保存。不是 JSON 的值,或空的 metadata,都會拒絕這次呼叫。

fare object 可以省略 amount 和 currency。有 amount 時必須是整數。浮點金額會拒絕這次呼叫。Android 要求提供的 currency 是小寫的 ISO 4217 代碼,即使沒有 amount。iOS 只在有 amount 時檢查 currency。

tripId 是你們這張工作的 id。一直用到 endTrip。beginTrip 交回 sessionId。把它跟這張預約一起保存。

下一步:行程。