Batch Check

Parameter specification

• Request URL

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

• HTTP Request Header:

• Request method

POST

• Request JSON body

• Content

• Example of request body

{
    "contents": [
        {
            "id": "1",
            "content": "测试语句1",
            "strategyId": "DEFAULT"
        },
        {
            "id": "2",
            "content": "测试语句2",
            "strategyId": "DEFAULT"
        }
    ]
}

• 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 <从上一步得到> + “\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

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:

Tag:

SubTag:

• 响应示例

[
    {
        "errorCode": 0,
        "textSpam": {
            "content": "fuck",
            "result": 0
        },
        "taskId": "367ef301-c627-4ae7-b23f-93d8219ade23",
        "language": "en",
        "startTime": 1699265265989,
        "endTime": 1699265268714,
        "id": "1"
    },
    {
        "errorCode": 0,
        "textSpam": {
            "content": "caonima",
            "result": 1,
            "tags": [
                {
                    "tag": 999,
                    "tagName": "用户自定义",
                    "level": 1,
                    "subTags": [
                        {
                            "subTag": 999001,
                            "subTagName": "用户自定义敏感词一类",
                            "wordList": [
                                "caonima"
                            ]
                        }
                    ]
                }
            ],
            "wordList": [
                "caonima"
            ]
        },
        "taskId": "4967e9d1-f4ca-47de-aa52-6e6b0372ddcc",
        "language": "Italian",
        "companyId": "1",
        "startTime": 1699265269127,
        "endTime": 1699265269138,
        "adRisk": 1,
        "id": "2"
    }
]

错误码

see text check Error Code