[Yeelink] Yeelink API*

目前本萌所在地的Yeelink已无法提供正常服务,所以这篇文章暂时作废,先不更新了!钦此~= ̄ω ̄=


在Yeelink平台中,是以设备为单位的管理的,每个真实设备会在你的账户里创建一个设备对象,而每个设备上又可以创建不同的传感器来对应到设备上的不同功能

API手册

  • 版本: 1.0
  • 协议: HTTP
  • 方法: GET/POST/PUT/DELETE
  • 域名: api.yeelink.net
  • 头信息: ApiKey

API参数

  • 参数都是JSON形式的结构体

API返回值

  • 如果没有返回值,则只返回HTTP报头
  • 如果有返回值,则返回JSON形式的结构体

API


设备

创建设备

方法 API 参数 返回值
POST /1.0/devices 设备信息 设备ID
  • 设备信息
    {
      "title":"轰扇", // 设备名称
      "about":"能吹出脑仁的风扇", // 设备描述
      "tags":["风扇", "智能"], // 多个设备关键词
      "location":{ // 地点
        "local":"深圳", // 地名
        "latitude":22.6, // 纬度
        "longitude":114.0 // 精度
      }
    }
    
  • 设备ID
    {
      "device_id": 1 // 新增设备的ID
    }
    

列举设备

方法 API 参数 返回值
GET /1.0/devices - 设备列表
  • 设备列表
    [
      {
        "id": 1, // 设备ID
        "title": "轰扇", // 设备名称
        "about": "能吹出脑仁的风扇" // 设备描述
      },
      {
        "id": 2, // 设备ID
        "title": "独眼", // 设备名称
        "about": "悚厉不安的摄像头" // 设备描述
      }
    ]
    

查看设备

方法 API 参数 返回值
GET v1.0/device/<设备ID> - 设备信息
  • 设备信息
    [
      {
        "title":"轰扇", // 设备名称
        "about":"能吹出脑仁的风扇", // 设备描述
        "tags":"风扇, 智能", // 多个设备关键词,用逗号隔开
        "local":"深圳", // 地名
        "latitude":22.6, // 纬度
        "longitude":114.0 // 精度
      }
    ]
    

编辑设备

方法 API 参数 返回值
PUT v1.0/device/<设备ID> 设备信息 -
  • 设备信息
    {
      "title":"轰扇", // 设备名称
      "about":"能吹出脑仁的风扇", // 设备描述
      "tags":["风扇", "智能"], // 多个设备关键词
      "location":{ // 地点
        "local":"深圳", // 地名
        "latitude":22.6, // 纬度
        "longitude":114.0 // 精度
      }
    }
    

删除设备

方法 API 参数 返回值
DELETE v1.0/device/<设备ID> - -

传感器

Yeelink目前定义的传感器有4种类型:

  • 数值型:type = value
  • GPS型: type = gps
  • 泛型: type = gen
  • 图像型: type = photo

创建传感器

方法 API 参数 返回值
POST /v1.0/device/<设备ID>/sensors 传感器信息 传感器ID
  • 传感器信息
    {
      "type":"value",
      "title":"test",
      "about":"test api",
      "tags":["tag1","tag2"],
      "unit":{
         "name": "temperature",
         "symbol": "C"
       }
    }
    
  • 传感器ID
    {
       "sensor_id": 1
    }
    

列举传感器

查看传感器

编辑传感器

删除传感器


数据流

创建数据点

查看数据点

编辑数据点

删除数据点


图像

上传图像

获取图像信息

下载图像


历史记录

历史通信记录

你可能感兴趣的:([Yeelink] Yeelink API*)