快速开始

Elaypay 提供 RESTful API 用于服务端对服务端集成。所有 API 端点使用 HMAC-SHA256 签名认证 进行安全访问。

基础 URL

https://api.elaypay.app/api/v1/

认证

每个 API 请求必须包含四个请求头：

请求头	说明
X-Api-Key	API 密钥标识符（sk_live_xxx）
X-Signature	请求的 HMAC-SHA256 签名
X-Timestamp	Unix 时间戳（秒）
X-Nonce	唯一请求标识符（UUID）

详见 认证指南。

快速示例

curl -X GET https://api.elaypay.app/api/v1/wallets \
  -H "X-Api-Key: sk_live_xxx" \
  -H "X-Signature: <computed_signature>" \
  -H "X-Timestamp: 1709337600" \
  -H "X-Nonce: 550e8400-e29b-41d4-a716-446655440000"

响应格式

所有响应遵循标准信封格式：

200 OK

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "ws_abc123",
    "workspaceName": "My Workspace"
  }
}

字段	类型	说明
version	string	API 版本
timestamp	number	响应时间戳（毫秒）
success	boolean	成功为 true，错误为 false
code	string	机器可读状态码
message	string	人类可读消息
data	object	响应数据（错误时为 null）

错误码

错误码按业务域前缀组织。完整目录请参阅 错误处理指南。

前缀	业务域
S	系统 / 参数校验
W	钱包
T	转账
GA	网关认证

分页

列表接口支持通过查询参数分页：

参数	默认值	说明
page	0	页码（从 0 开始）
size	20	每页条数（最大 100）
sort	各异	排序表达式（如 createdAt,desc）

详见 分页指南。

下一步

• 认证指南 — 设置 HMAC-SHA256 签名
• API 参考 — 浏览所有端点
• 错误处理 — 正确处理错误