接口列表

本节包含设备基本操作相关接口等。

接口列表如下：

添加设备

• 接口功能

  添加设备到账号下

• 请求地址

  https://open.ys7.com/api/lapp/device/add

• 请求方式

  POST

• 子账户token无权限请求

• 请求参数

• HTTP请求报文

POST /api/lapp/device/add HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888&validateCode=ABCDEF

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

删除设备

• 接口功能

  删除账号下设备（为保证该接口正常使用，请勿在萤石云APP开启终端绑定。如果该接口报错20031请手机登录萤石云视频客户端“我的”--“通用设置”--“账号安全”--“终端绑定”，关闭即可）

• 请求地址

  https://open.ys7.com/api/lapp/device/delete

• 请求方式

  POST

• 子账户token无权限请求

• 请求参数

• HTTP请求报文

POST /api/lapp/device/delete HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

修改设备名称

• 接口功能

  修改设备名称

• 请求地址

  https://open.ys7.com/api/lapp/device/name/update

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Update" "Resource":"dev:序列号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/name/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.cp894sbq65xa5niv0myrfdzma0ja7js1&deviceSerial=0&deviceName=5

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

设备抓拍图片

• 接口功能

  抓拍设备当前画面，该接口仅适用于IPC或者关联IPC的DVR设备，该接口并非预览时的截图功能。海康型号设备可能不支持萤石协议抓拍功能，使用该接口可能返回不支持或者超时。

  注意：设备抓图能力有限，请勿频繁调用，建议每个摄像头调用的间隔4s以上。

• 请求地址

  https://open.ys7.com/api/lapp/device/capture

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Capture" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/capture HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.12xp95k63bboast3aq0g5hg22q468929&deviceSerial=427734888&channelNo=1

• 返回数据

{
    "data": {
        "picUrl": "https://img.ys7.com//group2/M00/74/22/CmGdBVjBVDCAaFNZAAD4cHwdlXA833.jpg"
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段

• 返回码

NVR设备关联IPC

• 接口功能

  该接口用于NVR设备关联IPC

• 请求地址

  https://open.ys7.com/api/lapp/device/ipc/add

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/ipc/add HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777&validateCode=

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

NVR设备删除IPC

• 接口功能

  该接口用于NVR设备解除关联IPC

• 请求地址

  https://open.ys7.com/api/lapp/device/ipc/delete

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/ipc/delete HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&channelNo=1&ipcSerial=777777777

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

修改设备视频加密密码

• 接口功能

  该接口用于修改设备视频加密密码（设备重置后修改的密码失效）

• 请求地址

  https://open.ys7.com/api/lapp/device/password/update

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/password/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&deviceSerial=596510666&oldPassword=AAAAAA&newPassword=BBBBBB

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码

生成设备配网二维码

• 接口功能

  该接口用于生成设备扫描配网二维码二进制数据，需要自行转换成图片（300x300像素大小）。

• 请求地址

  https://open.ys7.com/api/lapp/device/wifi/qrcode

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Config" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/device/wifi/qrcode HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.0v1ksxnqdu5lxc2fak3ctbiq0r3269y9&ssid=8d6bi&password=Zhg%2C%2C222

• 返回数据

{
    "data": {
        "imageData": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQK5nxd/y5/8D/8AZaKK5cH/\r\nAB4/P8j3eJP+RXV/7d/9KRzNFFFe6flR6ZRRRXzJ+4hRRRQAV5nRRXp5d9r5fqfDcZ/8uP8At7/2\r\n0K6bwj/y+f8AAP8A2aiiunGfwJfL8zw+G/8AkaUv+3v/AElnTUUUV4Z+qhRRRQAUUUUAFFFFABXM\r\n+Lv+XP8A4H/7LRRXTg/48fn+R4fEn/Irq/8Abv8A6UjmaKKK90/KgooooAKKKKAP/9k=\r\n"
    },
    "code": "200",
    "msg": "操作成功!"
}

• 返回字段

• 返回码

• 说明

1、目前只有部分设备支持扫描配网二维码进行配网的功能，请确定您要添加的设备在以下支持功能的设备型号（设备型号可在设备底座标签上看到）列表中：

2、该接口获取的是二维码图片二进制数据，生成图片需要将该二进制数据转换为图片，以下提供JAVA转换示例代码（存储到本地）：

package com.ys7.open;

import sun.misc.BASE64Decoder;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;

public class TestQRCode {
    static String data = "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQK5nxd/y5/8D/8AZaKK5cH/\r\nAB4/P8j3eJP+RXV/7d/9KRzNFFFe6flR6ZRRRXzJ+4hRRRQAV5nRRXp5d9r5fqfDcZ/8uP8At7/2\r\n0K6bwj/y+f8AAP8A2aiiunGfwJfL8zw+G/8AkaUv+3v/AElnTUUUV4Z+qhRRRQAUUUUAFFFFABXM\r\n+Lv+XP8A4H/7LRRXTg/48fn+R4fEn/Irq/8Abv8A6UjmaKKK90/KgooooAKKKKAP/9k=\r\n";
    static BASE64Decoder decoder = new sun.misc.BASE64Decoder();

    public static void main(String[] args) throws Exception {
        base64StringToImage(data);
    }

    /**
     * 将二进制转换为图片
     *
     * @param base64String
     */
    static void base64StringToImage(String base64String) {
        try {
            byte[] bytes1 = decoder.decodeBuffer(base64String);
            ByteArrayInputStream bais = new ByteArrayInputStream(bytes1);
            BufferedImage bi1 = ImageIO.read(bais);
            File file = new File("D://QRCode.jpg");// 指定图片存储路径、图片名称和格式
            ImageIO.write(bi1, "jpg", file);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

3、接口获取的二维码二进制数据，可以直接写入HTML的img标签中，例如：

<img src="data:image/jpg;base64,...">  /*...填写生成的图片二进制数据即可*/

修改通道名称

• 接口功能

  修改通道名称

• 请求地址

  https://open.ys7.com/api/lapp/camera/name/update

• 请求方式

  POST

• 子账户token请求所需最小权限

  "Permission":"Update" "Resource":"Cam:序列号:通道号"

• 请求参数

• HTTP请求报文

POST /api/lapp/camera/name/update HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.cp894sbq65xa5niv0myrfdzma0ja7js1&deviceSerial=0&channelNo=1&name=test

• 返回数据

{
    "code": "200",
    "msg": "操作成功!"
}

• 返回码