平台API(v2.0)接口开发说明


1.API概述

为了满足客户和合作伙伴多样化需求,EMCP平台为用户提供了API接口功能,API接口是软件工程师使用支持HTTP/HTTPS协议的语言,通过此文档中API各数据定义的调用格式来编写代码,调用EMCP平台的数据的一个接口。用户可通过API接口方式单独获取所需设备的实时数据,历史数据,报警数据,对设备发送读写命令等操作.
开发者可基于此API 文档进行第三方系统的个性化开发,支持PC端浏览器的应用开发和移动端(安卓或iOS)App应用开发。甚至通过API能够轻松搭建出企业自主的物联网云平台系统,保持企业产品独立性,全面提升企业品牌影响力和竞争力。

2. API能够帮助企业做什么

2.1 将您的设备数据对接到第三方平台

可将设备数据对接到第三方的系统如 OA、ERP 、企业管理系统 、设备管理系统等,借助物联网技术,搭建企业完整的设备管理体系闭环

2.2搭建独立物联网云平台

EMCP平台API提供了丰富的接口列表,能够帮助您实现账户校验,设备查询,获取数据,设备读写等操作,您可以搭建一整套物联网云监控平台,适用于企业产品品牌独立性要求高的客户。

2.3.搭建独立数据分析平台

可搭建企业自主独立的的数据分析平台,通过API获取EMCP平台设备实时数据,历史记录,报警记录等,进行二次加工和运算,建立独立的数据分析管理平台

2.4快速构建移动端设备监控APP

可方便开发针对企业专属的移动端设备监控APP,适合企业有独立移动端办公或业务的场景。

3.如何接入API

API接口使用流程图
第一步、开通EMCP物联网云平台企业账号
您需要开通EMCP物联网云平台企业账号,将设备连接到平台后,能够正常采集和查看对应设备的数据。
第二步、 开通 API功能使用资格
联系本公司的商务人员,申请开通API配置功能使用资格,
第三步、创建应用
获得相应API功能授权后,您可以在API功能中创建您的应用,并获得相应AppKey,AppSecret,用于您的系统应用开发
第四步、接入开发
您可以根据此API文档提供的接口,通过AppKey、appSecret,对应账户的用户名称,调用接口获取访问令牌(accessToken),然后通过令牌调用open API接口获取数据,从而能够开发您专属的系统应用。

4.API相关说明

4.1AppKey用途

每一个应用都具有一个唯一的Appkey ,用于识别所创建应用的身份,通过AppKey、AppSecret,账户用户名称调用获取token接口获取访问令牌(accessToken),然后通过令牌调用open API接口才能正常获取数据

4.2调用限制

       系统中对于应用的等级划分为“初级”、“中级”、“高级”,不同等级调用限制次数不一样,默认创建的应用等级为“初级”,具体接口调用限制可见下表:
如果您对于调用限制有更多需求,您可以联系您的商务人员申请应用等级调整

4.3兼容性

支持HTTP/HTTPS协议
PC浏览器:Chrome、IE6+、Firefox、Opera、Safari
移动设备:iPhone、iPad、Android

5. 快速入门获取token

创建好应用后,您可以通过appKey、appSecret,用户名,调用获取token接口获取访问令牌(accessToken),本示例的中Appkey仅为演示使用,实际开发及上线时,请务必使用您申请的Key。
以下是javascript代码示例:
通过控制台输出结果,可查看已经成功请求接口,并获得accesstoken

6.API手册

6.1协议说明

服务器默认采用UTF-8编码,数据采用JSON格式
请求:Context-Type:application/x-www-form-urlencoded
响应:Context-Type:application/json charset=utf-8
返回时间统一采用UTC时间,北京时间,格式yyyy-MM-dd HH:mm:ss

6.2IP说明

API接口ip:http://api.lfemcp.com
图片地址ip:http://cdn.lfemcp.com/userimg/

6.3请求参数说明

除获取token的接口(${API接口ip}/token/get)外,其他接口的head中需要传入Authorization=“Bearer+空格+获取token接口得到的token的值”。

6.4返回数据格式

6.5接口列表

6.6 API接口详情

6.6.1获取token

接口功能
获取后续访问接口的令牌,
备注:token的有效时间为2个小时,重新获取token,会让旧token失效。
请求地址
${API接口ip}/token/get
请求方式
POST
请求参数
返回数据
返回字段

6.6.2获取账号下设备列表

接口功能
查询账号下所有设备的信息。
请求地址
${API接口ip}/equip/list
请求方式
POST/GET
请求参数
返回数据
返回字段

6.6.3获取设备实时数据

接口功能:
获取设备所有实时数据的列表
请求地址:
${API接口ip}/signal/list
请求方式:
POST/GET
请求参数:
返回数据
返回字段

6.6.4获取设备单个实时数据的历史数据

接口功能:
获取设备单个实时数据的历史数据
请求地址:
${API接口ip}/signal/history
请求方式:
POST/GET
请求参数:
返回数据
返回字段

6.6.5读写数据列表

接口功能:
查询读写数据列表
请求地址:
${API接口ip}/command/list
请求方式:
POST/GET
请求参数:
返回数据
返回字段

6.6.6设备某个读写数据发送读命令

接口功能:
对设备某个读写数据发送读命令
请求地址:
${API接口ip}/command/read
请求方式:
POST/GET
请求参数:
返回数据
返回字段

6.6.7设备某个读写数据发送写命令

接口功能:
对设备某个读写数据发送写命令
请求地址:
${API接口ip}/command/write
请求方式:
POST/GET
请求参数:
返回数据

6.6.8获取设备历史数据列表

接口功能:
获取设备历史数据列表
请求地址:
${API接口ip}/history/list
请求方式:  
POST/GET
请求参数
返回数据
返回字段

6.6.9获取设备报警数据列表

接口功能:
查询设备报警数据列表
请求地址:
${API接口ip}/alarm/list
请求方式:
POST/GET
请求参数:
返回数据
返回字段

7.错误码说明

8.常见问题                                                                                  

8.1 为什么请求不到数据

1)请检查设备,网关,数据规则等是否已连接并配置成功,是否在EMCP平台能够正常采集或存储数据
2)针对于获取历史数据和报警数据需要按照存储规则等待应数据已达到存储条件成功存储后,才可以成功请求。
3)请检查是否取得正确Appkey和AppSecret
4)如果上述都没有问题,将查看请求结果,对照错误码说明查找具体的原因

8.2 Token失效时间

Token有效期两个小时,超过两个小时token会过期,过期后将会用户鉴权失败,无法正常访问接口,请重新请求并获取token

8.3 CS架构系统或应用是否可以使用API服务

构建系统或应用的编程语言只要支持http/https协议均可接入API

8.4 token并未失效,但是请求接口失败

1)请检查是否为appkey停用或应用已删除
2)请检查的接口请求次数是否已经超出请求次数限制
3)查看是否同一个企业其他用户也在同时更新token

8.5 我想让我的客户也能使用API,是否可行

可以将API服务提供给您的客户使用,可按照如下流程操作:
1)可以将在EMCP平台中创建外部账号作为客户的企业账号
2)在API配置功能中,将您创建的应用授权给您客户的外部企业账号
3)可根据您的应用Appkey,AppSecret,客户外部账号的用户名生成新的accesstoken,根据新的用户鉴权,调取客户数据或为客户搭建对应应用。

9. 风格定制用户如何搭建企业自主API服务

针对于风格定制用户,如果有面向客户推广具备自己企业标识的API需求,您可以按照如下流程,搭建您的API服务
具体流程如下:
1.可以根据您企业的需求,申请一个域名,例如 www.uiot.com,建议您可以去万网或阿里云进行申请。
2. 申请并进行域名备案成功后,您可以创建对应的子域名,例如api.uiot.com
3. 您可以将您的子域名进行CNAME解析到到 api.lfemcp.com 域名
4. 成功将您的子域名解析后,您可以将API手册中的接口请求地址域名部分替换为您的域名,将EMCP平台平成替换为您的平台名称,替换后可作为您企业自主的API手册文档,提供给您的客户使用。
5. 在EMCP物联网云平台中, 点击API配置功能,您可以为您的客户单独申请一个应用,申请应用后,您可以将Appkey和AppSecret 告知客户,客户可根据新的Appkey和AppSecret和客户企业用户名进行用户鉴权,进而成功调取客户设备数据,搭建客户自己的系统或应用。
--------------------END--------------------
河北蓝蜂信息科技有限公司
技术支持:400-808-6168
官方网站:www.lanfengkeji.com
帮助中心 帮助中心
大约 1 年前
402

扫描下方二维码手机阅读文章

1 0