1. 接口引言
<h2>1.1 设计目标</h2>
<h5>为部署于企业用户局域网内的翼之盾™视频边缘处理终端提供 HTTPS API接口调用方式的接口服务。</h5>
<p>已发布支持的接口能力包括：</p>
<ul>
<li>视频处理任务接口</li>
<li>任务执行状态查询接口</li>
<li>终端状态查询接口</li>
</ul>
<p>其他接口服务持续更新中...</p>
<h2>1.2 适用范围</h2>
<p>本文档适用于通过 API 接入翼之盾视频边缘任务处理中台（<a href="https://video.189dun.com/"><a href="https://video.189dun.com/">https://video.189dun.com/</a></a>）的接入方。 预期读者为接入方技术及开发相关人员。</p>
<h2>1.3 相关术语</h2>
<h5>术语定义说明：</h5>
<ul>
<li>accessToken</li>
</ul>
<p>接入方的全局唯一接口调用凭据， 接入方调用各接口时都需使用accessToken；
accessToken 在其有效期内可重复使用， 在有效期内再次获取 acessToken 时， 旧的 accessToken 的有效期会重置，接入调试时需要注意。</p>
<ul>
<li>NVR模式</li>
</ul>
<p>视频边缘处理终端通过指定NVR IP及摄像头通道号（可多选），获取需要的视频内容。</p>
<ul>
<li>场所模式</li>
</ul>
<p>视频边缘处理终端通过预设的场所编号（已配置相应的NVR IP及摄像头通道号），获取需要的视频内容。</p>
<ul>
<li>FTP地址</li>
</ul>
<p>开发者设定视频处理后文件的上报FTP服务器，规则定义如下：</p>
<ol>
<li>接口参数为空，文件上报给边缘处理终端默认的FTP服务器地址，任务反馈：处理成功/处理错误；</li>
<li>接口参数齐全，FTP地址为边缘处理终端FTP白名单地址，文件上报给接口指定FTP服务器，任务反馈：处理成功/处理错误。</li>
<li>接口参数齐全，FTP地址不属于边缘处理终端FTP白名单地址，边缘处理终端不处理该条任务，任务反馈：无法处理。</li>
<li>接口参数错误，中台不接收该条任务，接口反馈：参数错误。</li>
</ol>
<h2>1.4 相关约定</h2>
<ol>
<li>所有接口为 HTTPS；</li>
<li>所有文字使用 UTF-8 编码；</li>
</ol>