一、业务端开发概述与接口规范

概述

本章节用于指导北向应用开发者，通过IOT平台API接口，获取设备实时数据、设备告警数据、设备事件和服务功能调用实现业务应用接入开发。

应用接入主要分为设备实时数据查询、设备实时控制、设备告警数据接收。IOT平台通过提供Http Rest API用于设备数据查询、设备实时控制和设备实时数据推送、设备告警数据接收。开发者可根据本文档说明基于IOT平台进行北向应用对接。

使用OpenAPI

一)、API简介

本API适用对象为用户侧北向应用开发者，供应用业务系统接入本IOT中继平台获取接入设备物模型定义数据、设备上报数据或向接入设备下发指令使用。

用户侧业务系统同本IOT中继系统平台通过http协议通讯，通过http接口调用实现从本IOT中继平台获取接入设备物模型属性、事件数据、设备上报数据或向接入设备下发执行指令。

二)、接口规范

1、基本术语

• 接口服务器地址（SERVER_URL）：接口的Http资源入口，通常为WebURL。

• 接口名称（INTERFACE）：特定功能的资源访问路径。

• 接口访问令牌（token）：接口调用时用于身份验证的内容,token为登录以后返回的登录信息，每次调用新的接口都需要使用登录后的token。

2、接口调用方式

POST/GET方式调用:(SERVER_URL)/(INTERFACE)

3、接口响应

接口响应内容为JSON格式报文:

响应代码:

4、接口调用URL说明

如果您使用IOT中继宝盒设备启用了内网穿透功能，在我司业务平台注册了子域名并与本设备进行了域名终端绑定， 那么本API调用接口调用URL地址则分为内网调用地址（通常为局域网内IP地址和端口）和外网调用地址（通常为域名地址和端口）， 在本文档后面各章节介绍时默认的API调用URL为内网调用地址，外网API调用地址为子域名加端口号组成，请注意区分。


例如你在我司业务平台申请了子域名 iotbox.iotrelay.cn ,在后面章节中的相关API接口地址会给出对应的子域名调用地址。