跳轉到主要內容
Fluz 在每個環境中只提供一個 GraphQL 端點。沒有版本化的 REST 路徑,也沒有依功能劃分的基底 URL——你只需將查詢或變更送到 /graphql,而權杖會決定你正在操作哪個帳戶。

端點

存取權杖是由位於 https://oauth-service.fluzapp.com 的獨立 OAuth 服務簽發。

請求結構

  • query — GraphQL 文件。使用具名操作(query GetWallet)以取得更佳的日誌紀錄。
  • variables — 型別化的輸入,將值與查詢字串分離。
  • operationName — 選用;當一個文件定義多個操作時很有用。

Queries 與 mutations

  • Queries 為唯讀(viewerwallettransactions)。
  • Mutations 會改變狀態(createVirtualCardpurchaseGiftCarddepositCashBalancecreateTransfer)。
涉及資金移動的 mutations 使用請求去重機制——參見 Idempotency

回應格式

GraphQL 一律以 HTTP 200 回傳,並包含 data / errors 外層結構:
失敗時,data 可能為 null,而 errors 會描述出錯原因——包含可供程式分支判斷的機器可讀 code。請參見 Errors

自省與綱要(Schema)

在 staging 中啟用了自省,你可以將 Apollo Studio 或 GraphiQL 等工具指向該端點。在 live 中,自省已停用;請改用 API reference 提供的已發佈綱要。

下一步

Authentication

Authorization 標頭中的權杖如何被簽發——針對你的帳戶或客戶的帳戶。

Errors

errors 陣列包含哪些內容以及如何依錯誤代碼進行分支。