API Reference

请求

1.接口地址

Client Api Url:https://pre-api-test.cmfbl.com/api/{bizType} Manager Api Url:https://pre-api-test.cmfbl.com/pass2/global/{bizType}

1.2 请求方式 POST

请求头信息,见 1.2.1 Header 请求参数
请求体信息,以content-type=application/json形式传输

1.2.1 Header 请求参数

参数类型是否必填项描述
companyIdlong必填公司id,由passTo提供
traceString必填全局链路唯一标志,保持唯一便于后续定位问题
timestamplong必填13位时间戳,请求发起时间
versionString非必填接口版本号,以具体业务接口为准
groupString非必填接口分组,以具体业务接口为准
langString非必填语言信息,默认en-US
tokenString非必填token信息,鉴权之后可获取

1.2.2 请求体参数

以具体业务接口为准

1.2.3 返回参数

参数类型描述
bizCodeString模块标识码,当前请求最终处理的服务模块,可为空
codeString状态返回码,code=0,标识当前请求操作成功,其他code标识操作失败
msgString异常时,返回错误信息,也可以按照错误码自定义提示
tmLong处理时长(毫秒)
traceString全局链路标志,与请求头中的trace保持一致,便于定位问题
msgParamsString返回状态描述中占位符参数串,多个参数间以,分割,用于处理状态描述中的变参信息,给用户友好的交互体验
dataObject数据体,统一返回各个业务响应信息,异常时返回bizType
okBoolean操作是否成功,成功=true,失败=false
failBoolean操作是否成功,成功=false,失败=true3
English
Powered by Localize
中文(简体)