NovaCloud-CN
    NovaCloud-CN
    • API接入指南
    • HTTP常见状态码
    • 信发
      • 播放器
        • 播放器管理
          • 获取播放器列表
        • 获取播放器状态
          • 获取播放器运行状态
          • 获取播放器配置状态
      • 节目
        • 紧急插播
          • 单页紧急插播节目
          • 撤销紧急插播节目
        • 节目组件
          • 手绘时钟组件
        • 常规节目
        • 离线导出
        • 超规格开关
        • 节目超规格检测
      • 实时控制
        • NTP对时
        • 同步播放
        • 窗口截图
        • 亮度调节
        • 音量调节
        • 视频源切换
        • 屏幕状态控制
        • 播放器重启
        • 电源控制
      • 定时控制
        • 定时屏幕状态
        • 定时重启
        • 定时音量调节
        • 定时视频源切换
        • 定时亮度调节
      • 日志
        • 播放日志
          • 批量查询播放日志概要
          • 批量查询播放日志详情
          • 查询单个播放日志详情
          • 查询单个播放日志概要
        • 远程控制日志
      • 通知
        • 视频源变更通知
        • 节目变更通知
    • 监控
      • 附录-监控信息注意事项说明
      • 设备状态监控
        • 接收卡
          • 基本信息
          • 监控信息
          • 告警信息
          • 拓扑信息
        • 显示屏
          • 监控信息
          • 显示屏列表
          • 显示屏详情
        • 主控设备
          • 基础信息
          • 告警信息
          • 运行参数信息
        • 智能模组
          • 监控信息
          • 告警信息
        • 输入源
          • 监控信息
        • 单元板/箱体
          • 监控信息
        • 监控卡
          • 监控信息
        • 摄像头
          • 摄像头配置
          • 摄像头监控聚合信息
      • 亮度日志
        • 亮度历史
    • 其他
      • 第三方系统授权登录
        • 获取用户列表
        • 获取登陆链接

    API接入指南

    引言#

            诺瓦云开放平台是诺瓦云开放生态的基础,为用户提供了全面的内容发布、设备管控和监控能力,助力打造智能化的数字信息发布解决方案。
            平台集成了 API 文档、在线调试工具等丰富资源,通过这一平台,用户只需编写少量代码,即可快速操作和调用诺瓦云服务,实现对 LED 显示屏的信息发布和监控运维。通过借助丰富的 API 资源,用户可以深度开展系统集成,提升现有 IT 系统的使用效能,从而带来更大的业务价值。
            诺瓦云开放平台提供了屏精灵和屏老板两大系统的功能能力:
    屏精灵 API 聚焦于信息发布和终端设备节目播放控制。通过 API 接口,用户可以获取播放器列表、播放器状态、播放器运行控制、节目发布控制以及播放日志等信息
    屏老板 API 则专注于终端设备和显示屏的运行状态监控。用户可以通过 API 接口,获取终端设备、显示屏的基本信息和运行状态数据
    此外,诺瓦云开放平台还提供了免密跳转到屏精灵的接口能力
            对于准备调用诺瓦云平台 API 的开发者而言,了解 API 调用的整个流程并掌握相关的技术细节至关重要。本文档将提供详细的介绍和指导,帮助开发者快速掌握 API 的调用方法,包括请求结构、鉴权认证等关键技术点。通过阅读本文,开发者将能够熟悉调用 API 的完整流程,并具备所需的技术能力,为在诺瓦云平台上开展开发工作做好充分准备。我们希望这份文档能为您提供有价值的参考和帮助。如有任何疑问,欢迎随时与我们沟通交流。

    平台功能#

    提供信息发布的接口调用方法,实现对 LED 显示屏的信息发布控制
    提供监控运维的接口调用方法,实现对 LED 显示屏整体链路上各类设备的运行状态进行监控
    支持 API 名称检索
    提供密钥的在线管理功能
    提供 API 在线调试功能

    支持设备范围#

    信发接口支持的设备范围:TU/TB/T卡系列
    监控接口支持的设备范围:MSD/MCTRL系列、V/VX系列、TU/TB/T卡系列

    接入准备#

    请准备上述支持的设备
    若使用信发 API 接口,请将设备绑定在屏精灵系统,可通过屏精灵桌面端软件或远程进行绑定
    若使用监控 API 接口,请将设备绑定在屏老板系统,可通过 NovaLCT 软件进行绑定或从屏精灵导入
    使用 API 开放平台之前,请先登录
    image.png
    image.png

    接入步骤#

    1
    获取应用接入秘钥(AK/AS)
    什么是应用接入秘钥AK/AS
    AK:AppKey ID 应用接入键标识,用于标识用户身份。一个用户有且仅有一个AK。
    AS:AppKey Secret 应用接入键秘钥,是一个用于验证您拥有该 AppKey 的密码。
    AK与AS一一对应,用户使用 AK/AS 生成 API 接口鉴权信息。
    如何获取AK/AS
            首先注册登录“诺瓦云开放平台”。诺瓦云服务在多个国家和地区独立部署,以确保数据的隔离和安全。为了访问您所在区域的云服务,请选择正确的节点登录。已有屛精灵、屏老板账号的用户可以直接登录。用户登录平台后自动获得AK/AS、API服务域名地址,用户默认拥有基础 API 接口的调用权限。用户通过企业认证后可以获得全部的 API 接口调用权限。
    image.png
    2
    确认请求地址(URL)
            诺瓦云服务根据不同的请求路径区分不同的请求。服务域名可在诺瓦开放平台内获取,具体 API 路径请参考 API 接口文档。
    请求协议:https
    服务域名示例:openapi-us.vnnox.com
    API请求路径示例:/v2/player/list
    结合请求协议、API服务域名、具体 API 请求路径,可以拼接为完整请求地址(URL)。
    示例:https://openapi-us.vnnox.com/v2/player/list
    3
    准备公共请求参数
            为保证 API 的安全调用,诺瓦云服务端会对每个 API 的访问请求进行身份验证。每个 API 需先配置 API 的公共请求参数,包括 :AppKey、Nonce、CurTime 和 CheckSum。公共请求参数需放在请求头(Request Header)中。公共请求参数类型均为字符串。
    参数说明
    AppKey接入标识。
    Nonce随机字符串(8~64个字符,仅限数字或英文字母)
    CurTime当前 UTC 时间戳,从 1970 年 1 月 1 日 0 时 0 分 0 秒开始到现在的秒数。为确保请求的真实性与及时性,客户端与服务端之间的时间戳误差应控制在5分钟以内。超过最大误差视为无效请求。
    CheckSum基于 AK/AS 生成请求签名,详见步骤四。CheckSum = SHA256(AppSecret + Nonce + CurTime)
    4
    生成请求签名(CheckSum)
            CheckSum 可通过将获取的 AppSecret 结合 Nonce 和 CurTime 这两个参数拼接成字符串,然后再进行 SHA256 哈希计算来生成。CheckSum = SHA256(AppSecret + Nonce + CurTime)
            计算生成 CheckSum 后,把值填入上一步的公共请求头中。诺瓦服务端在接收到 API 请求后,也会采用同样的方法进行 CheckSum 的计算与校验。
    Java示例
    Go示例
    Python示例
    PHP示例
    5
    组装具体 API 接口请求参数
    配置完公共请求参数后,您需继续配置相关 API 的具体业务参数。
    GET接口:业务参数以Content-Type: application/x-www-form-urlencoded方式在 URL 路径中传递
    POST接口:业务参数以Content-type: application/json; charset=utf-8方式在请求 Body 体内传递
    6
    应用发起请求
    请求示例:公共请求头参数准备
    请求示例:cURL模拟发送请求
    请求成功示例
    请求失败示例

    限流说明#

            为了确保 API 服务的稳定性和可用性,我们对 API 调用进行了限流措施。当用户的 API 调用频率超过限制时,服务器将返回 429 Too Many Requests 响应。请您合理安排 API 调用,避免触发限流措施,以获得最佳的 API 使用体验。如有任何疑问,欢迎随时与我们联系。
    每IP瞬时调用频率限制:每秒钟不超过15次
    每IP累计调用频率限制:每小时累计不超过1500次

    业务流程示例#

    显示屏信息发布业务流程示例
    image.png
    显示屏监控运维业务流程示例
    image.png
    下一页
    HTTP常见状态码
    Built with