Text Check

Parameter specification

• Request URL

https://tsafe.ilivedata.com/api/v1/text/check

• HTTP request Header

• Request method POST

• Request body JSON

• Example of request body

JSON Response

{
    "content": "fuck you",
    "userId": "1234556",
    "strategyId": "123"  //Not required, if it is empty, the default policy will be called.
}

• Request signature

When the user requests the Text Check API, the request can be signed with the appId and secretKey. When the API receives the request with the 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 returns 401 error.

• Request Header to send a signature via HTTP

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

 Authorization: ****

• 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 <get from previous> + "\n" +
                   "X-AppId:" + SAME_APPID_IN_HEADER + "\n" +
                   "X-TimeStamp:" + SAME_TIMESTAMP_IN_HEADER
   

The HTTP RequestURI 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. StringToSign as the signature string, secretKey as the secret key and SHA256 as the hash algorithm.

   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 & video.

appId=***
secrectKey=****
content="fuck you"
userId=1235678

Below is an example of request type.

{
 "content":"fuck you",
 "userId": "12345678"
}

Generate CanonicalizedQueryString

b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118

Generate StringToSign

  POST
  tsafe.ilivedata.com
  /api/v1/text/check
  b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118
  X-AppId:****
  X-TimeStamp:2020-07-31T07:59:03Z

Signatures from HMAC calculations

*****

HTTP Response

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

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

• Example of HTTP response

Description of returning json field

textSpam

tags

subTags

Position

• Response example

  JSON response

        {
       "errorCode": 0,
       "textSpam": {
           "content": "****",
           "result": 2,
           "tags": [
               {
                   "tag": 160,
                   "level": 2,
                   "tagName": "辱骂",
                   "tagNameEn": "insults",
                   "subTags": [
                       {
                           "subTag": 160001,
                           "subTagName": "谩骂人身攻击",
                           "subTagNameEn": "insults and personal attacks",
                           "wordList": [
                               "fuck"
                           ]
                       }
                   ]
               }
           ],
           "wordList": [
               "fuck"
           ]
        },
        "taskId": "c01b212f-3e31-4a2e-8346-b6f6ce3a3456",
        "startTime": 1660103900367,
        "endTime": 1660103900374
    }
  

Error Code