PUXELHUE
English
  • 简体中文
  • English
    PUXELHUE
    English
    • 简体中文
    • English
    • API使用说明
    • 1 鉴权
      • 1.1 用户登录
        POST
      • 1.2 读取节点公开信息
        GET
    • 2 设备
      • 2.1 读取节点信息
        GET
      • 2.2 执行系统恢复出厂
        PUT
      • 2.3 设置切换特效
        PUT
      • 2.4 设置swap
        PUT
      • 2.5 读取节点监测状态
        GET
    • 3 接口
      • 3.1 读取详细信息列表
        GET
      • 3.2 设置输出定位
        PUT
      • 3.3 设置画质
        PUT
    • 4 屏幕
      • 4.1 获取屏幕信息
        GET
      • 4.2 设置屏幕冻结
        PUT
      • 4.3 设置屏幕ftb
        PUT
      • 4.4 操作屏幕cut
        PUT
      • 4.5 操作屏幕take
        PUT
    • 5 图层
      • 5.1 获取图层完整信息
        GET
      • 5.2 获取图层模板列表
        GET
      • 5.4 设置图层换源信息
        PUT
      • 5.3 应用图层模板
        PUT
      • 5.5 设置图层选中信息
        PUT
    • 6. 场景
      • 6.1 获取场景详细信息列表
        GET
      • 6.2 场景创建
        POST
      • 6.3 单场景应用
        POST
      • 6.4 场景名称修改
        POST
      • 6.5 场景删除
        POST
    • 7 图库
      • 7.1 图片信息列表

    API使用说明

    1 环境准备#

    在调用相关API时,需确保以下环境:
    确保PC与设备通信正常

    2 基本使用步骤#

    打开相应API调用工具
    找到需要使用的接口信息
    根据接口协议调用相关API

    3 请求方式说明#

    3.1 调用格式#

    所有的API请求,必须按照如下格式调用
    协议调用前缀:http://ip:port/unico/+协议url (ip:设备地址,port:8088)
    例如:http://10.40.41.226:8088/unico/v1/node/open-detail
    http的header信息中必须填充下面信息:
    1.
    Authorization: token信息
    image.png
    token生成方法
    1.
    调用节点信息接口(不需要携带token)
    URL: http://ip:port/unico/v1/node/open-detail
    Method:get
    Query:
    {
        "nodeId": 1
    }
    Response:
    {
        "code": 0,
        "message": "ok",
        "data": {
            "sn": "1231231042541226",
            "startTime": "1718282915976"    }
    }
    2.
    客户端生成token
    var Secret = []byte("whatasecret")  //客户端通过调用UServer新增的节点信息接口,获取到的服务启动时间作为秘钥
    
    // jwt过期时间, 按照实际环境设置
    const expiration = 2 * time.Minute
    
    type Claims struct {
        // 自定义字段, 可以存在用户名, 用户ID, 用户角色等等
        SN string
        // jwt.StandardClaims包含了官方定义的字段
        jwt.StandardClaims
    }
    
    func GetToken(SN string) (string, error) {
        // 创建声明
        a := &Claims{
            SN: SN(open-detail接口返回的sn值),
            StandardClaims: jwt.StandardClaims{
                ExpiresAt: time.Now().Add(expiration).Unix(), // 过期时间
                IssuedAt:  time.Now().Unix(),                 // 签发时间
                Issuer:    "gin-jwt-demo",                    // 签发者
                Id:        "",                                // 按需求选这个, 有些实现中, 会控制这个ID是不是在黑/白名单来判断是否还有效
                NotBefore: 0,                                 // 生效起始时间
                Subject:   "",                                // 主题
            },
        }
        // 用指定的哈希方法创建签名对象
        tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a)
        return tt.SignedString(Secret)
    }

    3.2 调用举例#

    GET请求
    以获取节点信息为例:
    1、打开API调用工具
    image.png
    2、找到相关的API接口,根据IP与端口构造URL,把请求方式改为GET请求,并调用接口,获取结果
    企业微信截图_17442883898911.png
    PUT/POST请求
    以设置图层Z序为例:
    1、打开API工具后,将请求方式改为PUT请求,根据IP与端口构造URL,构造对应需要的json数据,下发接口信息,查看是否下发成功
    企业微信截图_17442883561629.png
    DELET请求
    以删除图层为例:
    1、打开API工具后,将请求方式改为DELETE请求,根据IP与端口构造URL,构造对应需要的json数据,下发接口信息,查看是否下发成功
    企业微信截图_17442884117018.png

    4 错误码#

    错误码字段描述
    0success成功
    非0failed失败
    修改于 2025-04-17 08:11:33
    下一页
    1.1 用户登录
    Built with