写在前面的话
API 2.0 是对小红砖开放平台 API 1.0的升级,新版接口主要规范与统一数据与错误返回格式,更加清晰直观地展示出接口的调用方式,并提高了接口调用的安全性,能够更好的满足 BIM开发者的二次开发需求。
统一数据返回格式
将调用接口获取的数据以标准的json格式返回,更加直观、清晰,方便开发人员按需获取
{
"code": 2000,
"message": "成功",
"data": [
{
"id": "components/21244801_0wI7AZgJP8Kh9LBEQqPr6K",
"key": "21244801_0wI7AZgJP8Kh9LBEQqPr6K",
"guid": "0wI7AZgJP8Kh9LBEQqPr6K",
"name": "家用热水 85",
"matrix": null,
"geometry": null,
"type": "IFCSYSTEM",
"lineid": 13885,
"model": "files/21244801",
"parent": null,
"children": null,
"systemtype": "家用热水",
"systemgroup": [
"21244801_0wI7AZgJP8Kh9LBEQqPp2o",
"21244801_0wI7AZgJP8Kh9LBEQqPp2q",
"21244801_0wI7AZgJP8Kh9LBEQqPp2w"
]
}
]
}
细化接口错误返回
根据接口的功能和业务逻辑,将错误返回细分成唯一错误码返回,让开发人员更加专注地针对错误码逐一处理,令需求更明确,处理更便捷
错误码 | 描述 |
---|---|
4900 | 缺少请求参数 |
4901 | 请求参数解析失败 |
4902 | 请求参数类型错误 |
4903 | 请求参数验证失败 |
4904 | 请求参数绑定失败 |
4905 | 请求方法不支持 |
4906 | 不支持当前媒体类型 |
4907 | 媒体类型不一致 |
5000 | 内部服务错误 |
5001 | 文件系统异常 |
提升数据获取安全性
将用户的唯一身份标识——开发密钥(devcode)的传参方式由 Url Parameter 更改为 Header 传参,确保身份标识的隐私性,提升数据获取安全性,让开发人员调用接口更放心
API 2.0 的功能是不是更强大了呢?大家快快去体验一下吧,会带给你更优质的享受哦~~~
链接请戳:小红砖 API 2.0
往期精彩:API1.0-获取模型所有构件基本信息