Skip to content

API 集成概述

SlaunchX API 专为 服务端到服务端 通信设计,使用 HMAC-SHA256 签名认证。当您的后端系统需要以编程方式与 SlaunchX 交互时(例如发起转账或查询钱包余额),可以使用该 API。

方面详情
认证方式HMAC-SHA256 签名
使用场景服务端到服务端,后端系统
凭证API 密钥 + 密钥(长期有效)
传输协议HTTPS
会话无状态(逐请求签名)

工作原理

每个 API 请求必须包含四个自定义请求头,这些请求头共同证明调用方拥有有效的 API 密钥并知晓对应的密钥。服务器在处理请求之前会验证这些请求头。

NameTypeRequiredDescription

快速示例

以下是一个经过认证的 API 请求在实际中的样子:

X-Signature 中的签名不是静态令牌——它会根据请求方法、路径、请求体、时间戳和随机数为每个请求重新计算。这意味着即使请求被截获,也无法被重放或篡改。

认证流程一览

┌──────────────┐                              ┌──────────────┐
│  您的服务器    │                              │   SlaunchX   │
└──────┬───────┘                              └──────┬───────┘
       │                                             │
       │  1. 构建规范消息                              │
       │     (method + path + timestamp +            │
       │      nonce + SHA256(body))                  │
       │                                             │
       │  2. 使用 HMAC-SHA256(secret) 签名            │
       │                                             │
       │  3. 携带 4 个认证头发送请求                    │
       │ ──────────────────────────────────────────> │
       │                                             │
       │        4. 服务器验证:                        │
       │           - 密钥存在且有效                     │
       │           - 时间戳在 60 秒内                   │
       │           - Nonce 唯一                       │
       │           - 签名匹配                          │
       │           - IP 已允许(若已配置)                │
       │           - 权限范围已授权                      │
       │                                             │
       │  <── 5. 响应(成功或错误) ─────────────────── │
       └─────────────────────────────────────────────┘

后续步骤

  • HMAC 认证 -- 签名计算的分步指南,包含 bash 和 Node.js 的完整代码示例。
  • API 参考与错误码 -- 错误码、API 密钥管理和技术规格。
  • 错误处理 -- 响应信封格式和完整的错误码目录。
  • 分页 -- 如何对大量结果集进行分页。

Lampay API 文档