结果获取接口规范

一、参数规范

请求 URL:

https://vsafe.ilivedata.com/api/v1/livevideo/check/result

接口描述:

该接口用于获取直播视频检测结果，检测结果包含截图证据信息及违规分类信息，通过taskId获取到检测的结果后，下次再调用，不会再次返回之前获取过的结果数据。

HTTP 请求Header:

Header	值	描述
Content-Type	application/json;charset=UTF-8	请求体类型
Accept	application/json;charset=UTF-8	接受的返回类型
X-AppId		项目的唯一标识，此值是 <控制台-服务配置>中的项目编号
X-TimeStamp		请求的UTC时间戳。需要把时间戳按W3C标准格式化，例如: 2010-01-31T23:59:59Z. (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization		签名值

请求方法:POST
请求体JSON对象：

参数	必需	类型	描述
taskId	必需	String	调用视频提交接口成功后，返回的任务id

请求体示例:

JSON response

  {
  "taskId": "f67fee0890de4c118d4f672b7c8ee304"
  }

请求签名:

当用户请求Video result API时，可以使用appId和secretKey对请求做签名，当API收到带签名信息的请求之后，将使用相同的算法验证签名，如果发现签名不一致，API将会返回401给用户。如果API验证签名一致，且appId对应的用户有权限操作请求的资源，则请求成功，否则API返回401。

如果API验证签名一致，且appId对应的用户有权限操作请求的资源，则请求成功，否则API返回401。

通过 HTTP 请求 Header 发送签名

方法: 在请求中加入名为 Authorization 的 Header，值为签名值。如下：

 Authorization: Njl86M/jY6zZaZoGhZdGO+GI/8+yGFECusGH1yQHUFE=

签名计算方法

构造规范化的请求字符串（Canonicalized Query String）::

将请求体JSON字符串以UTF-8字符编码做sha256编码后转换为16进制字符串（注意不是Base64）

CanonicalizedQueryString = hex(sha256(jsonBody))

构造被签名字符串 StringToSign ("\n" 代表ASCII里的换行符)

    StringToSign = HTTPMethod + "\n" +
                   HostHeaderInLowercase + "\n" +
                   HTTPRequestURI + "\n" +
                   CanonicalizedQueryString <从上一步得到> + "\n" +
                   "X-AppId:" + SAME_APPID_IN_HEADER + "\n" +
                   "X-TimeStamp:" + SAME_TIMESTAMP_IN_HEADER

HTTPRequestURI是请求URI的绝对路径，不包含请求串。如果HTTPRequestURI为空，也要保留一个正斜杠 ( / )

使用 HMAC-SHA256 协议创建基于哈希的消息身份验证代码 (HMAC)，然后计算签名。

StringToSign作为签名字符串，secretKey作为秘钥，SHA256作为哈希算法
```
有关 HMAC 的更多信息，请参阅 https://tools.ietf.org/html/rfc2104。
```
将上一步的结果转换为BASE64串
将BASE64串放入HTTP请求Header的Authorization

签名示例

下面是appId & secretKey & taskId的示例

appId=1000
secrectKey=d9e23d93053f49ade2f8fce185acedd4
taskId=f67fee0890de4c118d4f672b7c8ee304

下面是示例请求体

{
 "taskId": "f67fee0890de4c118d4f672b7c8ee304"
}

生成CanonicalizedQueryString

b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118

生成StringToSign

POST
vsafe.ilivedata.com
/api/v1/video/check/callback
b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118
X-AppId:1000
X-TimeStamp:2020-07-31T07:59:03Z

HMAC计算得到的签名

H0ZXsKUaiRotpxSiXW6+RgKRwnxHXy3qwlVzavs9iHo=

结果获取接口规范

一、 参数规范

一、参数规范