跳到主要内容

身份验证

GStable API 使用 API Key 进行请求的身份验证。你可以在 gstable 管理平台的 [API Key] 页面查看和管理你的 API Key。

Base URL

GStable 服务的所有 API 请求均发送至以下生产环境地址:

https://api.gstable.io/payment/v1

认证方式

GStable 遵循标准的 HTTP Bearer认证方案。在调用任何 API 接口时,请在 Header 中包含 Authorization 字段,格式为 Bearer 加上你的 API Key:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxx

示例代码

使用 curl 调用 API 的示例如下:

curl https://api.gstable.io/payment/v1/product/list \
-H "Authorization: Bearer sk_live_51Mz..." \
-H "Content-Type: application/json" \
-d '{
"limit": 10
}'
注意

请确保 Bearer 和 API Key 之间有一个空格。


API Key 类型

GStable 目前提供两种类型的生产环境密钥,通过前缀区分:

类型前缀描述与用途
Secret Key (密钥)sk_live_...全权限标准密钥。拥有对账户的完全控制权(创建链接、查询数据、退款等)。仅限在服务器端使用。
Restricted Key (受限密钥)rk_live_...只读或受限权限密钥。通常用于特定的查询操作或客户端集成。
安全警告

Secret Key (sk_live_...) 必须严格保密。

  • 绝对不要将其硬编码在前端代码(React, Vue, iOS, Android)中。
  • 绝对不要将其提交到 GitHub 等公共代码仓库。
  • 如果有泄露风险,请立即在管理后台进行密钥轮换。

关于测试环境

目前,GStable 仅提供主网 (Mainnet) 环境

由于区块链测试网(Testnet)上的 DEX 流动性池通常不稳定,无法准确模拟真实支付中的滑点和路由体验,为了保证集成的可靠性,我们建议直接在主网进行测试。

建议测试流程:

  1. 使用 sk_live 密钥集成。
  2. 创建低价格的产品。
  3. 使用真实钱包进行小额支付测试。
  4. 验证 Webhook 回调和订单状态变更。

认证错误

如果 API Key 缺失、无效或已过期,API 将返回 HTTP 401 状态码。这通常是唯一会返回 401 的情况。

常见原因:

  • Header 格式错误(忘记了 Bearer 前缀)。
  • 使用了被撤销的 Key。
  • Key 拼写错误。