提示:IP、POST、token、【(sub,subrout,submkt)订阅消息】,是独立于文档的,您需要向我们获取此类信息然后带入到文档即可,我们并未严格区分字符串和josn,所以请进行通用解析,即可通用我们所有市场。
请求连接
演示
ws.connect ws://{IP}:{POST}/websocket/json/{token}
输出:json
结构:参考 输出结构和错误代码
返回json:{“Cmd”:”connect”,”State”:0,”Msg”:”ok”}
订阅单个合约调用演示
单次最多可订阅300个产品。数量较多请使用按分类订阅
ws.send /sub/(产品代码)
演示范例: /sub/XAUUSD,AUDGBP
协议:WS
参数:routs,string,必填,完整产品代码,多个用逗号分隔。
输出:json
结构:参考 输出结构和错误代码
返回{“State”:1,”Msg””…. 代表成功
按照产品/分类进行订阅
演示
ws.send /subrout/NYMEX
调用协议
演示范例:/subrout/(产品代码,市场代码)
协议:WS
参数:routs,string,必填,完整产品代码,多个用逗号分隔。
输出:json
结构:参考 输出结构和错误代码
返回{“State”:1,”Msg””…. 代表成功
按交易所进行订阅
ws.send /submkt/NSE,US
演示范例:/submkt/(交易所代码)
协议:WS
参数:routs,string,必填,完整代码,多个用逗号分隔。
输出:json
结构:参考 输出结构和错误代码
返回{“State”:1,”Msg””…. 代表成功
说明:订阅成功后,系统即接收来自服务端的消息,输出数据字段参考行情实体结构
注意:订阅失败请做日志,方便诊断问题,重复多次订阅命令建议间隔5秒执行,或应使用批量订阅。
重连机制
发送心跳命令,维持连接。
如果服务器240秒内没有收到来自用户端的心跳命令或者服务器向用户端发送三次信息未收到来自用户端的心跳命令回复信息将自动中断该客户端连接。
心跳命令发送:定时每15-60秒内,向服务器端发送心跳命令。
判断是否断开:两次发送心跳命令没有收到服务器主动回复,则代表已经断开连接,执行重连。
心跳命令调用演示
ws.send /heartbeat/PING
调用协议
范例:/heartbeat/PING
协议:WS
输出:json
结构:参考 输出结构和错误代码
返回json:{“Cmd”:”ping”,”Msg”:”ok”}。
不应频繁重连,掉线重连间隔要间隔5秒以上,否则系统可能会临时屏蔽来自该编码或IP的连接。
建立的连接数不应超过允许的最大连接数,最大数为1,如果显示已经登陆无法连接,请确定是否有其他地方连接,间隔5分钟再重新连接。
发送命令建议间隔5秒以上。