跳转到主要内容
生成令牌
使用此接口获取业务令牌。你的服务器使用 API secret 对请求签名,并在 X-BH-APIKEY 请求头中发送 API key。响应包含一个 token(在需要认证的请求中通过 X-BH-TOKEN 请求头发送)和一个 expireTime。
在此调用成功之前,VelaFi 必须为你的账户开通 API 访问权限,且 API key 必须配置 IP 白名单。请求必须来自该白名单中的 IP 地址。参见认证。

接口地址

在沙盒环境中测试时,请使用 https://api-test.velafi.com/v2/token/generate 及你的沙盒环境凭证。

请求头

string
必填
你的 API key。

查询参数

integer
必填
当前 Unix 时间(毫秒),例如 1740568725231。
string
必填
以 API secret 为密钥,对字符串 timestamp=<timestamp> 计算 HMAC-SHA256,并编码为小写十六进制。
查询参数中只能发送 timestamp 和 signature。服务器会使用去掉 signature 参数后的查询字符串来验证签名。只有这两个参数时,被签名的字符串恰好为 timestamp=<timestamp>。

如何签名

1

构造消息

获取当前 Unix 时间(毫秒),并构造字符串 timestamp=<ms>,例如 timestamp=1740568725231。
2

计算 HMAC

以 API secret 为密钥,计算该消息的 HMAC-SHA256。
3

对结果进行十六进制编码

将 32 字节的结果编码为 64 个字符的小写十六进制字符串。这就是 signature。

响应字段

integer
成功时为 200。出错时返回负数代码;参见错误。
string
成功时为 SUCCESS,否则为错误信息。
object

示例

Response

错误

出错时返回 HTTP 状态码 400 以及负数 code:

使用令牌

在 X-BH-TOKEN 请求头中发送令牌:
请在 expireTime 之前申请新令牌。使用已过期或未知的令牌进行调用将失败,并返回代码 -1022。