Result Obtaining Interface Specification

Request specification

• Request URL:

Get it from the Console - Service Configuration

• Interface description:

The interface is used to obtain the results of video detection which include screenshot evidence, prohibited content and its classification.

• HTTP Request Header:

• Request method:POST

• Request body JSON object:

• Example of request body:

  JSON response

    {
    "taskId": "f67fee0890de4c118d4f672b7c8ee304"
    }
  

• Request signature:

When the user requests the Video result API, the request can be signed with the appId and secretKey (obtained from the “Console - Service Configuration”). When the API receives the request with signature information, it will verify the signature using the same algorithm, and if the signature is found to be inconsistent, the API will return 401 error to the user.

If the API validation signature is consistent and the user corresponding to the appId has permission to operate the requested resource, the request succeeds, otherwise the API will return 401 error.

• Send signatures via HTTP Request Headers

Method: Add a header named Authorization in the request, whose value is the signature value. For example:

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

• Signature calculation method

1. Canonicalized Query String

Convert the request body JSON string to a hexadecimal string (not Base64) by doing sha256 encoding with UTF-8 character encoding.

CanonicalizedQueryString = hex(sha256(jsonBody))

2. Constructs the signed string StringToSign ("\n" stands for ASCII newline character):

   StringToSign = HTTPMethod + “\n” + HostHeaderInLowercase + “\n” + HTTPRequestURI + “\n” + CanonicalizedQueryString + “\n” + “X-AppId:” + SAME_APPID_IN_HEADER + “\n” + “X-TimeStamp:” + SAME_TIMESTAMP_IN_HEADER

The HTTPRequestURI is the absolute path to the request URI, without the request string. If the HTTPRequestURI is empty, also keep a forward slash (/)

The hash-based message authentication code (HMAC) is created using the HMAC-SHA256 protocol and the signature is calculated.

3. The hash-based message authentication code (HMAC) is created using the HMAC-SHA256 protocol and the signature is calculated.

   For more information about HMAC, see: https://tools.ietf.org/html/rfc2104。
   

4. Converting the results of the previous step to a BASE64 string

5. Put the BASE64 string into the Authorization of HTTP request Header

• Example of signature

Below is an example of appId & secretKey & taskId.

appId=1000
secrectKey=d9e23d93053f49ade2f8fce185acedd4
taskId=f67fee0890de4c118d4f672b7c8ee304

Below is an example of request body.

{
 "taskId": "f67fee0890de4c118d4f672b7c8ee304"

　　 }

Generate CanonicalizedQueryString

b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118

Generate StringToSign

 POST
 asafe.ilivedata.com
 /api/v1/audio/check/result
 b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118
 X-AppId:1000
 X-TimeStamp:2020-07-31T07:59:03Z

Signatures from HMAC calculations

H0ZXsKUaiRotpxSiXW6+RgKRwnxHXy3qwlVzavs9iHo=

HTTP Response

Content-Type: application/json;charset=UTF-8

The result is in JSON format, please refer to the following example.

• HTTP response

Description of returning json field:

audioSpams:

tags:

subTags:

• Example of response:

  JSON response

    {
                "errorCode": 0,
                "code": 0,
                "result": 2,
                "taskId": "nx_10e04ba8-367d-462e-b7a0-437a12acbba1_1616666938669",
                "audioSpams": [{
                    "startTime":18.0,
                    "endTime":20.0,
                    "text": "fuck you",
                    "tags": [{
                        "tag": 100,
                        "level": 2,
                        "subTags": [{
                            "subTag": 130001,
                            "wordList": [
                                "fuck"
                            ]
                        }]
                    }]
                }],
                "language":"zh-CN"
            }
  

Error code