跳到主要内容

身份验证请求

查询会话状态​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "session.status"
}

查询WebSocket连接的状态,检查用于授权请求的API密钥(如果有的话)。

权重: 2

参数: NONE

数据源: 缓存

响应:

{
"id": "b50c16cd-62c9-4e29-89e4-37f10111f5bf",
"status": 200,
"result": {
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A", // 如果连接未经过身份验证,则为 `null`。
"authorizedSince": 1649729878532, // 如果连接未经过身份验证,则为 `null`。
"connectedSince": 1649729873021,
"returnRateLimits": false,
"serverTime": 1649730611671,
"userDataStream": true // User Data Stream 订阅是否有效?
}
}

退出会话​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "session.logout"
}

忘记之前认证的API密钥。 如果连接未经身份验证,此请求不会有任何作用。

请注意,session.logout请求后,WebSocket连接仍然保持打开状态。 你可以继续使用连接,但现在必须在需要的地方明确提供apiKey和signature参数。

权重: 2

参数: NONE

数据源: 缓存

响应:

{
"id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
"status": 200,
"result": {
"apiKey": null,
"authorizedSince": null,
"connectedSince": 1649729873021,
"returnRateLimits": false,
"serverTime": 1649730611671,
"userDataStream": false // User Data Stream 订阅是否有效?
}
}

用API key登录 (USER_DATA)​

{
"id": "5494febb-d167-46a2-996d-70533eb4d976",
"method": "session.logon",
"params": {
"timestamp": 1770736694138,
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
}
}

使用提供的API密钥进行WebSocket连接身份验证。

在调用session.logon后,将来的需要apiKey和signature参数的请求可以省略它们。

请注意,只能认证一个API密钥。 多次调用session.logon将更改当前已认证的API密钥。

注意: 仅支持 Ed25519 密钥用于此功能。

权重: 2

参数:

名称类型是否必须描述
apiKeySTRINGYES
recvWindowDECIMALNO最大值为 60000 毫秒。 支持最多三位小数的精度(例如 6000.346),以便可以指定微秒。
timestampLONGYES用于请求签名的 Unix 时间戳,单位为毫秒或微秒。该值必须反映客户端当前时间,并会在签名接口中由服务器进行校验。
signatureSTRINGYES

数据源: 缓存

响应:

{
"id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
"status": 200,
"result": {
"apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
"authorizedSince": 1649729878532,
"connectedSince": 1649729873021,
"returnRateLimits": false,
"serverTime": 1649729878630,
"userDataStream": false // User Data Stream 订阅是否有效?
}
}