请求
1.接口地址=>HTTP
DEMO如下:
请求方式: POST
1.2 请求
1.2.1 Header 请求参数
参数 | 类型 | 是否必填项 | 描述 |
---|---|---|---|
companyId | long | 必填 | 系统唯一公司标识 |
trace | String | 必填 | 全局链路唯一标志 |
timestamp | long | 必填 | 时间戳,毫秒 |
version | String | 非必填 | 接口版本号 |
group | String | 非必填 | 接口分组 |
lang | String | 非必填 | 语言信息,默认zh-CN |
token | String | 非必填 | token信息,登录之后,后续所需 |
1.2.2 请求体参数
参数 | 类型 | 是否必填项 | 描述 |
---|---|---|---|
bizBody | JSON | 必填 | 请求信息体,JSON |
1.2 接口地址=>websocket
DEMO如下:
传入参数:
参数 | 类型 | 是否必填项 | 描述 |
---|---|---|---|
header | JSON | 必填 | 与http保持一致 |
body | JSON | 必填 | 与http保持一致 |
DEMO如下:
心跳格式如下:bizType固定为ping
心跳返参消息体格式如下:bizType固定为pong
返回参数:
参数 | 类型 | 描述 | |
---|---|---|---|
code | String | 系统通用返回码。0-成功,其他异常 | |
msg | String | 返回信息 | |
bizCode | String | 模块标识码 | |
tm | Long | 处理时长(毫秒) | |
trace | String | 全局链路标志信息 | |
msgParams | String | 返回描述中占位符参数串,多个参数间以,分割 | |
data | Object | 数据体,统一返回各个业务响应信息,异常时返回bizType |
Last updated