運作方式
- 請求 — 具有相應
REQUEST_*權限範圍的使用者呼叫request*mutation。API 驗證輸入並將請求排入佇列。該 mutation 回傳的是messageId,不是approvalId。 - 建立 — Fluz 會建立一筆待處理的核准,並指派帳戶管理者為核准者。你的應用程式會收到包含
approvalId的APPROVAL_CREATEwebhook。 - 清單(選用) — 具有
LIST_APPROVALS的核准者可呼叫approvalRequests以擷取該帳戶的未結請求。 - 核准或拒絕 — 具有
MANAGE_APPROVALS的核准者呼叫approveApprovalRequest或declineApprovalRequest。核准後,Fluz 會執行所請求的動作。 - Webhook — 你的應用程式會收到
APPROVAL_APPROVE或APPROVAL_DECLINE。若核准後執行失敗,你可能會收到APPROVAL_HANDLER_ERROR。
請求以非同步方式處理。提交請求後,輪詢approvalRequests或監聽 webhook 以取得approvalId。
共用作業
以下作業適用於所有核准請求類型。列出待處理核准
approvalRequests
回傳已驗證帳戶的未結(PENDING)核准請求。
必要權限範圍: LIST_APPROVALS
核准請求
approveApprovalRequest
核准一筆待處理請求。成功後,Fluz 會執行與該請求關聯的動作(例如建立虛擬卡)。
必要權限範圍: MANAGE_APPROVALS
拒絕請求
declineApprovalRequest
拒絕一筆待處理請求。不會執行任何下游動作。
必要權限範圍: MANAGE_APPROVALS
應用程式權限範圍
與核准相關的權限範圍必須同時在應用程式層級(由 Fluz 授與)與使用者層級(透過 OAuth 同意或generateUserAccessToken)獲得授與。
請參閱 Authentication 以了解權限範圍如何被授與與驗證。
請求類型
每種請求類型皆有專屬指南,包含輸入欄位、範例與 webhook 識別碼。
Webhooks
在 Fluz 開發者入口中設定 webhook。核准事件使用與其他 Fluz webhook 相同的傳遞機制。請參閱 Developers overview 以進行設定與驗證。APPROVAL_CREATE 負載
approvalType 與 approvalCode 來識別請求類型。各類型指南會列出該請求的對應值。
APPROVAL_APPROVE / APPROVAL_DECLINE 負載
approvalAction 為 DECLINE,且 approvalStatus 為 DECLINED。
APPROVAL_HANDLER_ERROR 負載
在請求已被核准但下游動作失敗時傳送(例如,執行時餘額不足)。認證
核准相關的 mutation 視你的整合模式而定,支援 Bearer token(使用者 OAuth)與 Basic Auth(應用程式 API 金鑰)。已驗證主體會成為請求人。 請使用具備必要權限範圍的 User Access Token。請參閱 Authentication & Authorization Guide。錯誤處理
請求類的 mutation 會回傳RequestApprovalResponse:
success: false 並包含 error 物件。