Skip to main content
Fluz API 在每個環境中皆為單一 GraphQL 端點。本頁為GraphQL API 的運作方式之參考補充。

瀏覽參考文件

查詢(Queries)

讀取操作 — 取得錢包、交易、商家、卡片優惠與帳戶資料。

變更(Mutations)

寫入操作 — 核發卡片、移轉資金、註冊使用者與企業,以及管理核准流程。

型別

物件(Objects)

查詢與變更所回傳的回應結構。

輸入物件(Input objects)

傳遞給操作的引數。

列舉(Enums)

固定的一組允許值,例如狀態與卡片網路。

聯合(Unions)

會解析為多個物件型別之一的欄位。

介面(Interfaces)

由多個物件實作的共享欄位契約。

純量(Scalars)

基本值,例如 DateTime 與 UUID。

慣例

驗證

Authorization 標頭、權杖端點,以及 OAuth 授權重新導向。

錯誤

錯誤包裝、網域代碼前綴,以及重試指引。

速率限制

依表面(surface)的請求限制與 429 的樣貌。

分頁

偏移量輸入、頁面大小上限,以及連線式回應。

REST 端點

有一個操作在 GraphQL 之外 — 用於獨資業者註冊的檔案上傳。

端點

存取權杖會透過相同端點的 generateUserAccessToken 變更產生,並以你的 API Key 授權 — 參見驗證

標頭

回應包裝

  • data — 成功的載荷(發生錯誤時可能為部分資料)。
  • errors — 失敗陣列,每個項目包含 codemessagepath

綱要(Schema)

Staging 開放內省,因此你可以直接將工具(Apollo Studio、GraphiQL、codegen)指向該環境。在 live 中,請向你的帳戶團隊索取目前的 SDL。