Skip to main content
Fluz API 在每个环境中都是单一的 GraphQL 端点。本页是GraphQL API 的工作原理的参考补充。

浏览参考

查询(Queries)

读取操作 —— 获取钱包、交易、商户、卡片优惠和账户数据。

变更(Mutations)

写入操作 —— 发卡、转账、注册用户和企业,以及管理审批。

类型

对象(Objects)

查询与变更返回的响应结构。

输入对象(Input objects)

你传递给操作的参数。

枚举(Enums)

固定的允许值集合,例如状态与卡网络。

联合(Unions)

解析为多个对象类型之一的字段。

接口(Interfaces)

由多个对象实现的共享字段契约。

标量(Scalars)

原始值,例如 DateTime 和 UUID。

约定

认证(Authentication)

Authorization 头、令牌端点,以及 OAuth 授权重定向。

错误(Errors)

错误封装、域代码前缀,以及重试指南。

速率限制(Rate limits)

各表面请求限制,以及 429 的含义。

分页(Pagination)

偏移量输入、页面大小上限,以及连接式响应。

REST 端点

有一个操作在 GraphQL 之外 —— 独资注册所用的文件上传。

端点

访问令牌通过 generateUserAccessToken 变更在同一端点签发,使用你的 API Key 授权 —— 参见认证

请求头

响应封装

  • data —— 成功的负载(在错误时可能为部分数据)。
  • errors —— 失败项数组,每项包含 codemessagepath

模式(Schema)

Staging 开放了自省,因此你可以直接将工具(Apollo Studio、GraphiQL、代码生成)指向它。在 live 环境,请向你的客户团队索取当前的 SDL。