API接口列表

更新时间:2018-12-29 16:54:46

飞象工业互联网平台开放API列表查看

登录飞象工业互联网平台,左侧导航栏点开【服务调用】菜单,点击【API接口列表】,即可浏览飞象工业互联网平台对外开放的全部API列表,可以按照接口类型过滤,也可以根据名称或关键词搜索API。

注意:
若是设备已经关联项目,则使用项目appkey;若是设备没有关联到项目,则使用租户appkey去调用。

开放API分为以下几大类:

  • 设备转储类接口 (已发布)

  • 物的管理类接口 (已发布)

  • 数据源服务类接口(已发布)

  • 项目管理类接口(已发布)

  • 设备文件类接口(已发布)

  • 工业插件类接口API(已发布)

  • 用户服务类接口 (未发布)

  • 基础工具类接口 (未发布)

  • 用户系统类接口 (未发布)

  • 一方插件类接口 (未发布)

  • 规则服务类接口 (未发布)

image.png | center | 826x364

飞象工业互联网平台开放API详情查看

服务端接口列表页面,点击API列表操作列【查看详情】,进入【服务端接口列表>接口详情】页面,即可查看选中API详情。并且通过“调用测试”可以对API进行在线的测试调用。
开放API详情分为4大部分:
API基本信息
包括API名称,域名,协议,版本,服务路径,调用方式
请求参数列表
包括输入参数名,数据类型,参数示例
返回结构体
正常返回参数实例
异常返回参数实例
错误码描述
包括错误码,返回信息,描述

image.png | left | 747x349

*注意:通过“调用测试”功能对API进行在线调用测试时,如果参数类型是"JSON字符串",则需要在字符串两端添加引号标注(即添加" "),及对"JSON字符串"的内包含的符号添加转义符号(即"\",如上图所示)。

results matching ""

    No results matching ""