在鸿云文档

Appearance

云云对接开发指南 ​

云云对接流程 ​

获取accessKey和accessSecret ​

调用平台API接口前需要进行认证，由平台管理员添加账号信息后，分配accessKey和accessSecret

获取Token ​

接口描述 ​

根据accessKey和accessSecret换取Token

接口地址 ​

xxx/gateway/oauth-server/v2/oauth/token

xxx：根据部署环境来确认

请求方式 ​

post

Content-Type：application/json

请求参数 ​

参数名数据类型是否必填描述
grantTypestring是鉴权类型,api调用对接固定为:api_access
accessKeystring是accessKey
accessSecretstring是秘钥accessSecret

请求示例 ​

json
{
    "grantType": "api_access",
    "accessKey": "84b168da55b34d8cbddaa59a991cf0b1",
    "accessSecret": "84b168da55b34d8cbddaa59a991cf0b2"
}

响应结果 ​

参数名数据类型描述
codestring调用成功，返回0，其他为调用失败，查看错误信息。
msgstring调用成功，提示"操作成功"，调用失败，查看错误信息。
dataObject返回结果。结果内容详情，查看下方示例。
  accessTokenstringtoken 默认过期时间120分钟,过期需重新获取
  tokenTypestringtoken类型
  refreshTokenstringapi对接账号暂未用到此字段
  redirectUristringapi对接账号暂未用到此字段

响应示例 ​

json
{
    "code": "0",
    "msg": "操作成功",
    "data": {
        "accessToken": "06bdd72ea01a41e68910b106b97e6369",
        "refreshToken": null,
        "tokenType": "bearer",
        "redirectUri": null
    }
}

：access_token有有效期，请调用客户端根据有效时长定期获取新的accessToken

调用API-查询产品列表示例 ​

接口描述 ​

查看所有产品列表

接口地址 ​

xxx/gateway/openapi

请求方式 ​

post

Content-Type：application/json

请求头 ​

在访问API接口时需在head中带两个参数 和

tokenauthorization是从token接口获取

apiCode接口定义的编码

参数名数据类型是否必填描述
tokenauthorizationstring是平台颁发的accessToken
apiCodestring是需要调用的API接口编码：queryProductList

请求参数 ​

参数名数据类型是否必填描述
productKeyListList<String>是产品key列表,当列表为空时，查询所有产品数据

请求示例 ​

json
{
  "productKeyList": []
}

响应结果 ​

参数名数据类型描述
codestring调用成功，返回0，其他为调用失败，查看错误信息。
msgstring调用成功，提示"操作成功"，调用失败，查看错误信息。
dataObject返回结果。结果内容详情，查看下方示例。
  productIdstring产品ID
  productKeystring产品Key
  productNamestring产品名称
  productSecretstring产品密钥
  secretTypestring产品加密类型：
  • TRIPLET-三元组加密
  • ID²-ID²加密
  • CERT-设备证书
  linkProtocolstring协议类型：
  • MQTT
  • Modbus
  • OPC-UA
  • HTTP
  • TCP
  • 其它
  connectModestring连网方式：
  • wifi-WiFi
  • 4G-4G/3G/2G
  • lora-蓝牙
  • ethernet-网线
  dataTypestring数据格式：
  • json-JSON
  • binary-二进制码流
  deviceAuthModestring设备认证方式 默认secret，secret：密钥认证
  productDescstring备注
  vendorsstring厂商
  modelstring产品型号
  dataStatusstring数据状态：
  • publish-已发布
  • developing-开发中
  createTimestring创建时间：格式为yyyy-MM-dd HH:mm:ss
  deviceNumsInteger产品下的所有设备数量
  activeNumsInteger激活的设备数量

响应示例 ​

json
{
  "code": "0",
  "msg": "操作成功",
  "data": [
    {
      "productId": "9e080e25ce344e34828c7eb10b5383e1",
      "productKey": "T2ahgQhiQ",
      "productName": "添加产品",
      "productSecret": "e10c4a46876f3462",
      "secretType": "TRIPLET",
      "linkProtocol": "HTTP",
      "connectMode": "wifi",
      "dataType": "json",
      "deviceAuthMode": "secret",
      "productDesc": "开鸿智谷备注",
      "vendors": "开鸿智谷",
      "model": "产品型号",
      "dataStatus": "developing",
      "createTime": "2023-10-10 18:54:12",
      "deviceNums": 0,
      "activeNums": 0
    }
  ]
}

更多开放api接口 ​

接口编码描述
createScenes创建场景规则
createProduct创建产品
queryProduct查询产品
queryProductList查询产品列表
deleteProduct删除产品
listDeviceByProductKey根据产品ProductKey查询设备列表
publishProduct发布产品
revokePublish撤销发布
importTSL导入物模型
obtainVersionId获取VersionId
registerDevice注册设备
queryDevice查询设备
queryDeviceList查询设备列表
deleteDevice删除设备
queryDeviceMsg查询设备消息
updateDevice更新设备描述
sendDeviceMsg发送设备消息
updateScenes更新场景规则
deleteScenes删除场景分组

实时数据推送订阅 ​

平台配置数据转发规则，转发指定实时数据到三方Kafka，三方服务订阅Kafka获取设备实时数据。