Skip to main content
批次 API 讓你的應用程式能在一次呼叫中跨許多已連結的 Fluz 使用者執行動作,而不必一次又一次以單一使用者權杖迴圈呼叫。此功能是為需要代表連結至你應用程式的使用者讀取資料或(即將推出)移轉資金的 OAuth 應用程式開發者所打造。
這與虛擬卡片下的「Create Virtual Card Bulk Order」操作不同,後者會為「單一」帳戶建立多張卡片。批次 API 則是跨「你已連結的使用者」運作。

誰可以使用

批次 API 以應用程式層級控管。你的應用程式必須由 Fluz 啟用批次 API 能力——請與我們聯繫以申請存取權。非批次啟用的應用程式所發出的呼叫將以 BulkApiAccessDenied 被拒絕。

驗證

所有批次 API 呼叫均使用以你的應用程式 API 金鑰(你的 client_idclient_secret)進行的 Basic 驗證,而非使用者存取權杖:
端點(staging):
端點(production):

授權來自既有連線

批次 API 不會建立新的同意介面。只有在使用者對你的應用程式具有有效的 OAuth 授權時,該使用者才可被觸及,且每個操作都僅在使用者已授與該操作所需的範圍(scopes)時才被允許。批次存取絕不會比等價的單一使用者操作更寬鬆。
  • 中斷連線會移除授權,因此中斷連線的使用者將不再可被觸及。
  • 如果使用者的授權僅限於特定的消費帳戶,該使用者的批次結果將自動限制於那些帳戶。

選取目標使用者

每個批次操作都需要 targetSpec
  • 以你在連結時提供的 externalReferenceId 指定使用者——不是以 accountId
  • 同步請求最多可指定100 個目標
  • 未以 externalReferenceId 連結的使用者無法被個別選取;只能透過 ALL_CONNECTED 觸及。使用 Discover Connected Users 來查看誰已連結以及他們授與了哪些範圍。

每個目標的失敗合約

單一目標的失敗不會使整個請求失敗。每個結果都會帶有 success,且當 successfalse 時會包含 error 整個請求只會因應用程式層級的問題而被拒絕:未啟用批次、無效的請求、超過 100 個目標上限,或當所有請求的目標都無法解析時。 每個回應也會彙總 targetCountsuccessCountfailureCount

同步與非同步

  • 受限範圍的讀取為同步,並在回應中直接提供:最多 100 個目標,且具每個目標的限制(例如各 20 筆交易、90 天期間)。本章節文件化的即是這三個查詢。
  • 寫入與大型匯出為非同步(即將推出):你提交作業、輪詢其狀態,並下載結果。同步讀取中的 hasNextPage/totalCount 會告訴你何時該改用匯出,而不是默默截斷。

本節中的操作