调用接口服务
更新时间:2020-03-13 10:13:55
智能人居开放平台的核心能力是通过API服务的形式实现的。
调用接口服务要了解基础协议、API的定义和分类,以及支持工具。
协议
智能人居开放平台使用IoT标准请求协议,介绍了所有API遵循的标准协议。
定义
API定义在API Reference节可以找到。
通用定义描述了API的通用返回结果、分页参数、身份信息、列表参数和ID参数的说明
错误码定义描述了小于1000的统一错误码,和以62开头的智能人居API的错误码。
分类
根据调用方分为:
云云接口服务
- 平台服务
- 基础服务:关于用户、设备、空间、场景API的说明;
- 扩展服务:关于领域服务API的说明;
移动端接口服务
- 配网服务:在配网流程中用到的API
- 设备服务
- 安全服务
注意:
云云接口服务不允许从移动端(Android, iOS)访问,网关会做白名单控制。
业务方务必不要在移动端调用云云接口,避免业务受到影响。
工具
API网关客户端
API网关客户端是访问API的简单工具,可以提供对IoT网关API的便利的访问方法。
智能人居APISDK
智能人居API SDK是使用API网关客户端对智能人居API进行封装,提供1对1接口级的访问方法和调用动态配置,配置运行环境后,可以直接使用智能人居的API服务,忽略接口名、参数的返回值的封装。