Skip to main content
Fluz 在每個環境都提供單一 GraphQL 端點。沒有依功能區分的基底 URL——你只需將 query 或 mutation 送到 /api/v1/graphql,由權杖決定你正在操作哪個帳戶。

端點

存取權杖會透過相同端點以 generateUserAccessToken mutation 建立,並使用你的 API Key 授權——請參閱 Authentication

請求結構

  • query — GraphQL 文件。使用具名作業(query GetWallet)可獲得更好的記錄。
  • variables — 具型別的輸入,讓值不出現在 query 字串中。
  • operationName — 選填;當文件定義多個作業時很實用。

Queries 與 mutations

  • Queries 為唯讀(viewerwallettransactions)。
  • Mutations 會改變狀態(createVirtualCardpurchaseGiftCarddepositCashBalancecreateTransfer)。
與金錢移動相關的 mutations 使用請求去重——請參閱 Idempotency

回應格式

GraphQL 一律以 HTTP 200 回傳,並包含 data / errors 包裹:
失敗時,data 可能為 null,而 errors 會描述發生的問題——包含可供你分支處理的機器可讀 code。請參閱 Errors

自省與結構描述

Staging 啟用自省,因此你可以將 Apollo Studio 或 GraphiQL 等工具指向該端點。在 live 環境,自省已停用;請改用 API reference 中發布的結構描述。

下一步

Authentication

Authorization 標頭中的權杖如何被建立——無論是你的帳戶或客戶的帳戶。

Errors

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