跳转到主要内容

SDKs & Libraries

通过使用适用于 TypeScriptPythonGoPHPJavaKotlinC#RubyReact Native 的官方 SDK 加快您的集成。这些库简化了 API 请求、身份验证和错误处理,让您能够专注于构建出色的支付体验。

环境 URL

了解更多关于测试模式与实时模式的信息。

API 密钥管理和身份验证

1

Access API Keys

在仪表板中导航至 开发者 → API 密钥 来管理您的密钥。
2

Generate a New Key

选择 添加 API 密钥,提供一个描述性名称,并配置写入权限:
  • 启用写入权限(已勾选):对所有 API 操作具有完全的读写权限
  • 启用写入权限(未勾选):只读访问 - 只能获取数据(支付、订阅、客户、产品)。无法创建或修改资源。
对于仅需查看数据而不进行更改的仪表板集成、分析工具以及其他系统,请取消选中“启用写入权限”。
3

Store Your Key Securely

立即复制生成的密钥并确保其安全存放。
4

Authenticate Your API Requests

使用您的 API 密钥对所有请求进行身份验证。采用以下授权格式:
Authorization: Bearer YOUR_API_KEY
切勿在客户端代码或公开仓库中暴露您的秘密 API 密钥。

响应格式

{
  "id": "pay_1234567890",
  "status": "completed",
  "amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

速率限制

我们的 API 使用具有突发保护功能的双窗口速率限制系统。限额基于您的身份验证方式和业务等级来应用。

默认限额(等级 0)

窗口限额
每秒(突发)40 次请求
每分钟(持续)240 次请求

业务等级

对于拥有更高 API 需求的企业可获取更高的速率限制:
等级突发(每秒)持续(每分钟)
等级 0(默认)40240
等级 11001,000
等级 25005,000
联系支持以将您的业务升级到更高的速率限制等级。

未经身份验证的请求

不带有效身份验证头的请求按 IP 地址限速:
窗口限额
每秒(突发)20 次请求
每分钟(持续)100 次请求

速率限制响应头

通过以下响应头监控您的使用情况:
  • X-RateLimit-Limit - 允许的最大请求数
  • X-RateLimit-Remaining - 当前窗口中剩余的请求数
  • X-RateLimit-Reset - 速率限制重置的时间
当您超过速率限制时,API 会返回 429 Too Many Requests 响应。请在重试逻辑中实现指数退避。

错误处理

若要有效管理错误,请参阅 错误代码交易失败 部分以获取详细指导。

Webhooks

接收有关支付事件的实时通知。请参阅我们的Webhook 指南以获取设置说明。

Webhook Guide

设置 Webhooks 以获取实时通知和事件处理。