集成平台开发规范之io开发规范-yb体育官方

• 调用接口后会对南向系统带来状态变化或者为了获取某些参数的值而调用该接口，接口名称建议用动宾结构，如“增加人脸库”、“获取实况播放地址”。
• 其他类型的接口名称，用名词的词组结构，如“人脸比对”。
• 对于io接口，因为roma平台要求接口的url和名称具有唯一性，建议在前面加上前缀，如“ei人员匹配_增加人脸库”。

以“t”开头，io标准topic以“t_io”开头，只能包含英文字符和下划线。

智慧园区亚博平台下载的解决方案的io开发和交付是多租户场景，topic名称需要添加双下划线 租户名后缀，如租户名是test，topic名称是t_io_device_datachanged__test。

响应消息要求必须包含rescode，resmsg两部分组成。

rescode：返回码，“0”表示接口调用成功，“-1”表示接口调用失败。

resmsg：消息请求结果简要描述。

接口调用成功的响应消息类似如下内容。

{
 "rescode": "0",
 "resmsg": "success",
 "result": {
  xxxx
 }
}

接口调用失败的响应消息类似如下内容。

{
    "rescode": "-1",
    "resmsg": "repositoryname is required.",
    "result": null
}

• io开放给io framework调用的请求方法仅支持post，设计时需要注意，所有南向io接口应都设计为post请求方法。
• 输入参数格式推荐使用json、text/xml和文件流。
• 建议南向系统提供https请求协议，减少安全扫描风险。
• 南向两个或两个以上api访问路径相同时，多个南向接口合并为一个接口提供为北向，或者一对一提供，因为roma不支持多个api访问路径相同