WebSocketwss://decrypt.nikola-lab.cn/openapi/v1/decrypt/result/notify(解密结果主动推送)
此接口用于给您的服务端维持一个WS长连接,监听连接期间产生的解密结果的变化。使用此接口,您可以一定程度上减少主动查询解密结果的频率
| 参数 | 参数类型 | 值类型 | 备注 |
|---|---|---|---|
| appId | query | string | 你的appId |
| timestamp | query | string | unix标准时间戳 |
| nonce | query | string | 随机数 |
| signature | query | string | 签名的HEX,请阅读下方文档了解如何生成签名 |
| signature_method | query | string | 对签名进行hash化的算法 |
- 由于WebSocket的特性导致参数只能放在 querystring 中进行传输
- 生成签名和签名算法的相关说明请参考此文档:签名文档
- WebSocket不支持返回错误消息,请严格按照上方链接的文档进行鉴权过程的处理,避免出错且无法通过异常消息调试而浪费宝贵的时间。
- 如果您遇到任何 HTTP 500 的错误码,请与我司联系进行错误排查,而如果是 HTTP 400 的错误码,请自查鉴权过程的参数是否正确
- 此WebSocket接口的鉴权过程与Http接口的鉴权过程需要的参数是一致的,您可以考虑复用HTTP的鉴权参数的生成函数
- ⚠️ 此接口是只读接口,请勿往此接口写入任何数据。否则会导致链接返回错误消息然后链接被关闭且状态码为1008
- ⚠️ 与其他的HTTP API相同,此WebSocket API仅限于存在于服务端调用,否则会导致appSecret泄露而导致接口盗刷
- ⚠️ 以下两种情况下,此WS接口不会上报解密结果的变化,因此请您一定要配合 主动轮询解密状态和结果 接口使用
- 在还未完成WS链接的之前,解密任务已完成
- 重复提交的类型和参数相同的任务
通知数据格式
| 参数 | 参数类型 | 值类型 | 备注 |
|---|---|---|---|
| uuid | json | string | 任务的UUID |
| keysOrLink | json | string | 秘钥或者大秘钥BIN文件的下载链接 |
关于 keysOrLink 参数的描述请看此文档:解密结果文档
通知数据示例
json
{"uuid":"60886f32-2633-4ae2-8300-df68edb8d5a6", "keysOrLink":"abbbecebe56f"}