关于opapi调试工具调试海康API

ISC调试工具

文件夹内有个默认的Http_Openapi.exe.config文件，里面可以改软件的默认配置，改合作方内容即可

默认配置，就是一打开软件就不用填的内容
  <appSettings>
    <!--合作方Key-->
    <add key="AppKey" value="甲方提供的key码一般都是数字">
    </add>
    <!--合作方Secret-->
    <add key="Secret" value="甲方提供的密钥，一般多是英文">
    </add>
    <!--接口调用协议-->
    <add key="Protocol" value="Http">调用协议，大多数是https
    </add>
    <!--平台地址-->
    <add key="PlatAddr" value="10.33.48.56:80">平台的地址+端口号
    </add>
    <add key="ClientSettingsProvider.ServiceUri" value=""/>调用的URL
  </appSettings>

 一.获取设备列表：用HTTPS协议请求post的url:

/api/nms/v1/online/camera/get

返回的"regionIndexCode": "设备唯一编码",非常重要

**//获取设备列表

调用最多的就是这个设备唯一编码，
"regionIndexCode": "设备唯一编码",


获取列表url
/api/nms/v1/online/camera/get

请求参数：
{
  "pageNo": 1,
  "pageSize": 1000
}

返回的值就是设备列表信息、例：


{
  "code": "返回码，0 – 成功，其他- 失败，",
  "msg": "返回描述",
  "data": {
    "pageNo": 数据信息,
    "pageSize": 每页记录数,
    "totalPage": 总页数,
    "total": 总记录数,
    "list": [
      {
        "deviceType": 设备型号,
        "regionIndexCode": "设备唯一编码",
        "collectTime": "采集时间",
        "deviceIndexCode": 区域编码,
        "ip": ,
        "regionName": "区域名字",
        "indexCode": "资源唯一编码",
        "cn": "设备中文名称",
        "treatyType": "协议类型",
        "manufacturer": 厂商，hikvision-海康，dahua-大华,
        "port": 端口，监控点无此值,
        "online": 在线状态，0离线，1在线
      },

二,获取监控视频流

上一段我们获取到设备的唯一编码，接下来要用这段唯一编码取监控点的视频流

URL填下面这个，其他甲方参数不变
/api/video/v2/cameras/previewURLs

协议：HTTPS
请求：
/api/video/v2/cameras/previewURLs
HTTP：POST
安全认证：认证



请求参数：
contentType：
application/json

请求body
{
    "cameraIndexCode": "监控点唯一标识",
    "streamType": 码流类型，0:主码流 1:子码流 2:第三码流 参数不填，默认为主码流,
    "protocol": "取流协议，“hik”:HIK私有协议，使用视频SDK进行播放时，传入此类型；“rtsp”:RTSP协议；
“rtmp”:RTMP协议；“hls”:
HLS协议（HLS协议只支持海康SDK协议、EHOME协议、ONVIF协议接入的设备；只支持H264视频编码和AAC音频编码；云存储版本要求v2.2.4及以上的2.x版本，或v3.0.5及以上的3.x版本；ISC版本要求v1.2.0版本及以上，需在运管中心-视频联网共享中切换成启动平台内置VOD）。
参数不填，默认为RTSP协议",
    "transmode": 传输协议（传输层协议），0:UDP 1:TCP 默认是TCP 注：EHOME设备回放只支持TCP传输 GB28181 2011及以前版本只支持UDP传输,
    "expand": "streamform=ps",
    "streamform": "ps"/输出码流转封装格式，“ps”:PS封装格式、“rtp”:RTP封装协议。当protocol=rtsp时生效，且不传值时默认为RTP封装协议。
}



返回结果

{
    "code": "0",
    "msg": "success",
    "data": {
        "url": "获取到的视频流"
    }
}

三.操作设备运行，转向，聚焦等PTZ动作

用HTTPS协议请求post的url:/api/video/v1/ptzs/controlling

请求的url:/api/video/v1/ptzs/controlling

协议：HTTPS
请求：
/api/video/v1/ptzs/controlling
HTTP：POST
安全认证：认证
请求body

{
    "cameraIndexCode": "设备唯一编码",
    "action": 0-开始 1-停止,
    "command": "GOTO_PRESET",、不区分大小写 
 LEFT 左转 RIGHT右转 UP 上转 DOWN 下转 ZOOM_IN 
焦距变大 ZOOM_OUT 焦距变小 LEFT_UP 左上 LEFT_DOWN 
左下 RIGHT_UP 右上 RIGHT_DOWN 右下 FOCUS_NEAR 
焦点前移 FOCUS_FAR 焦点后移 IRIS_ENLARGE 光圈扩大
 IRIS_REDUCE 光圈缩小 WIPER_SWITCH 接通雨刷开关 
START_RECORD_TRACK 开始记录轨迹 
STOP_RECORD_TRACK 停止记录轨迹 START_TRACK 开始轨迹 
STOP_TRACK 停止轨迹 以下命令presetIndex
不可 为空： GOTO_PRESET到预置点
    "speed": 4,、云台速度，取值范围为1-100，默认50
    "presetIndex": 20、预置点编号，整数，通常在300以内
}

返回

{
    "code": "0",/返回码，0-成功，其它-失败
    "msg": "success",/返回描述
    "data": ""，/为空
}