Home

系统间接口协议说明（HTTP方式）

统一标准的 输入/输出 完成 app 与后台 api 交换数据，协议说明如下

• 服务URL: 用一个固定的URL互相接收请求，

• webapi 服务 URL

http://host:port/?body={...} (具体格式由使用方提供)

• 参数名称：body
• 参数结构：json

输入参数：

{
  "service":"业务名",
  "method":"方法名",
  "sn":"全局唯一的UUID，用于对应日志",
  "params":{"参数名A":"参数值A","参数名B":"参数值B"}
}

参数说明：

• service: 业务接口注册名，因为URL统一，所以要区别业务类型需要使用此参数；
• method: 具体的业务方法，和 service 参数组合使用，用来区别某个业务的某个方法；
• sn: 请求流水号，要求全局唯一，建议使用 UUID，用来对应联调的日志；
• params: 供业务方法使用的参数，具体参数内容，参考具体的接口说明；

返回值说明：

统一格式的返回，其中 success 标识请求是否成功，返回 true 则 entity 为 object，object 格式由具体的接口定义 返回 false 则表示请求异常，其中 entity 为 exception 信息

{
    "sn":"请求流水号"
    "success": true / false, 
    "entity": object / exception
}