开放平台开发文档

Appearance

移动千里眼Web能力接入手册 ​

一.准备工作 ​

中国移动千里眼是以移动高清智能为特色的融合视频监控产品，可提供多样化的视频解决方案。千里眼以服务移动场景为亮点，兼容传统固定监控场景，对所支持移动和固定两类监控设备进行统一管理，并为各行业提供智能化的监控应用，是对传统视频监控业务的全面升级。

移动千里眼WEB 端地址:https://qly.andmu.cn/normal/login

千里眼官网:https://qly.ipower.10086.cn/

1.1 在移动千里眼WEB端获得超管及企业信息 ​

在实际的对接过程中，往往是由技术人员进行对接，但是技术人员可能第一次接触移动千里眼平台。因此在对接开始之前，对接人员需要准备以下材料。

  1. 询问业主方（提出对接业务的需求方），要求其明确本次对接是获取【移动千里眼】那个企业下的数据。要求提供企业对应的超级管理员的账号、密码。
  2. 根据账号、密码登录移动千里眼WEB端：https://qly.andmu.cn/normal/login
  3. 选择企业：选择业主方提供的企业。在移动千里眼中，一个用户账号下可以有多个企业。每个企业都有组织目录以及管理员。设备下挂到企业的一个组织目录下。
  4. 查看企业信息【我的企业-企业信息】
  • 查看企业的创始人，如果该企业的创始人不是登录的账号，请找业主方（提出对接业务的需求方），要求其提供企业的创始人的账号。企业创始人的账号称为企业的超级管理员，拥有该企业的所有权限。只有超级管理员才有权限对数据进行开放，其他账号无权限。
  • 记录企业编码，后续会使用到。
到此为止，我们已经准备好了本次开发对接工作的数据：  企业编码，企业对应的超级管理员的账号、密码。

1.2 在开放平台门户上申请行业视频集成应用 ​

  • 打开频能力开放平台: 开放平台 点击右上角的注册按钮，注册账号。

  • 进入 控制台->行业视频集成应用

  • 开放平台账号独立于千里眼平台，需要单独注册申请。

  • 进入 行业视频集成应用->视频能力 填写信息。 

  此处需要特别注意：关联业务的意思是，将视频能力开放平台的应用与移动千里眼的企业关联。
  这样就可以通过应用的信息获取企业的数据。此处必须是企业的超级管理员的账号、密码。
  • 申请应用完成后待管理员审核，审核可能需要3-5个工作日。 待审核完成后，登录开放平台控制台，可看到审核完成的记录。

1.3 接口文档 ​

接口文档地址：https://open.qly.cmviot.cn/doc/api/README.html

  • 总体规范：首先查看总体规范，明确接口的签名规则。每个接口请求都必须按照次规则进行签名
  • 根据需求，查看你所需的接口或者SDK的使用说明。

很多问题接口文档就可以解决，请仔细查看接口问题，避免无谓的报错。

二.查看应用信息和调试工具 ​

2.1 查看应用信息 ​

  • 应用审核通过后，可以查看应用详情以及应用的配置
  • 点击应用详情和应用配置，可查看接入移动千里眼视频平台需要的appID，secret， RSA密钥等信息

2.2 调试工具 ​

  • 点击【调试】按钮，跳转调试工具面板，就可以针对一些接口进行调试，查看接口的返回数据。
  • 【选择接口】-【生成header】-【生成body】-【发送】
  • 第一个接口应该是获取token.获取token之后，token会自动填充，然后就可以调试其他接口

注意：

  • 需要鉴权的接口请先用获取token接口获取token
  • 接口的body需要自己根据实际的参数填写。body生成的按钮只是给你展示需要那些字段，字段的具体数值请根据实际填写

三.接入调试 ​

开放平台接口调用，需要遵循 Api 总体规范 统一鉴权，建议用户在自己平台进行包装后，提供接口给前端WEB使用。

3.1 获取token ​

参考接口Api获取鉴权Token 获取统一鉴权的Token

3.2 获取设备列表 ​

参考接口Api获取设备列表

3.3 获取某个摄像机的实时缩略图。 ​

参考接口Api获取摄像机实时缩略图

3.4 获取某个摄像机的播放链接，该功能可以返回一个全量的播放功能，包括直播，回看，云台，语音对讲等。 ​

参考接口Api获取摄像机视频播放WebSDK链接

注意：该链接只能使用一次，且到达失效时间后失效

获取到的链接在浏览器中打开后如下图：

3.5 获取某个摄像机的直播链接，该功能只能返回直播画面。 ​

参考接口Api获取摄像机纯视频播放链接 获取到的链接在浏览器中打开后如下图：

3.6 获取某个摄像机的回放链接，该功能只能返回特定时间段内的回看视频。 ​

参考接口Api获取摄像机指定时间段回看WebSDK链接

四. FAQ ​

Q:开放平台是否支持推流到三方平台。
A:不支持，开放平台只支持三方平台来拉流。

Q:获取了播放地址，我应该怎么做才能播放视频。
A:播放地址获取后，需要使用视频播放器才能播放视频。如果是使用的SDK，SDK是自带播放器的，所以不用另外的播放器，如果只是获取的播放地址，则需要客户使用自己的播放器来播放。

Q:开放平台能否提供单独的播放器。
A:不能。开放平台提供的播放器是与千里眼的业务绑定的。

Q:为什么我获取的播放地址在播放器不能播放，其他地方的视频流地址播放器是可以播放的。
A:请确认视频是否是H265编码格式，有些播放器不支持H265编码格式。

Q:我的设备是H265编码格式的，但是我的播放器只支持H264编码格式，平台是否能够把H265编码转码成H264。
A:不能，转码涉及资源消耗，平台不支持转码。

Q:我刚刚获取的token，怎么一会儿就提示过期了。
A:同一个时间，只有一个token生效，后生成的token将强制使之前的token失效。请检查是否其他地方或者其他同事获取了token。目前token过期有特定的返回码。建议定期获取新的token，同时在接收到token过期的错误码之后，立即获取新的token。

Q:我不想通过接口获取播放地址，能否提供一个静态播放地址给我，我配置到系统就可以实时播放。
A:不支持，静态播放地址容易造成风险扩大。

Q:为什么我调用接口提示APPID不存在。
A:出于安全考虑，接口的调用必须要进行签名，具体方式请参考: https://open.qly.cmviot.cn/doc/api/README.html#_1-消息头规范

Q:为什么我调用接口提示签名认证失败。
A:这种提示一般是签名有误，请参考文档:https://open.qly.cmviot.cn/doc/api/README.html#_3-响应码 ，建议采取以下的方式排查问题：
1、检测头部参数是否有误。
2、生成的签名字符串是否有误。
3、根据示例的参数，计算签名，判断签名函数是否有误。

Q:为什么我签名也对了，但是还是出现数据验证失败的错误。
A:这种提示一般是body参数有误，必须保证计算MD5的body数据与传输到服务器的body数据是一致的。

Q: 以下这两个接口有什么区别：获取摄像机视频播放WebSDK链接 、获取摄像机纯视频播放websdk链接。
A: 第一个接口获取的地址，在播放的时候，时间抽回绘制告警。第二个则不会。见下图。

Q:通过接口获取摄像机纯视频回看播放链接获取的回放视频流怎么无法播放。
A:请确认参数是否有误，endTime与startTime必须是毫秒。

Q:为什么我访问开放平台接口超时，访问其他地方没有问题。
A:检查机器是否被入侵，有可能进行了非法扫描被拉入了黑名单。

Q:由于安全策略，我的服务器需要配置白名单，能否提供白名单的域名或者IP地址。
A:千里眼的设备接入到的是全国不同的机房，是一个动态调整的过程，无法给出具体的域名或者IP地址。 并且机房的建设也一直在进行中，不停的有新机房的加入。