同步单条检测

参数规范

• 请求 URL:

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

• HTTP 请求Header:

• 请求方法: POST

• 请求体JSON:

• 请求体示例:

  {
      "content":“fuck you”,
      "userId":"1234556",
      "strategyId":"123"   //非必传，如为空，则调用默认策略
  }

• 请求签名:

当用户请求Text Check API时，可以使用appId和secretKey对请求做签名，当API收到带签名信息的请求之后，将使用相同的算法验证签名，如果发现签名不一致，API将会返回401给用户。

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

• 通过 HTTP 请求 Header 发送签名

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

 Authorization: ****

• 签名计算方法

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

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

CanonicalizedQueryString = hex(sha256(jsonBody))

2. 构造被签名字符串 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)，然后计算签名。

3. StringToSign作为签名字符串，secretKey作为秘钥，SHA256作为哈希算法

   有关 HMAC 的更多信息，请参阅 https://tools.ietf.org/html/rfc2104。
   

4. 将上一步的结果转换为BASE64串

5. 将BASE64串放入HTTP请求Header的Authorization

• 签名示例

下面是appId & secretKey & content的示例

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

下面是示例请求体

{
 "content":"fuck you",
 "userId": "12345678",
 "checkTags": [150,160]
}

生成CanonicalizedQueryString

b3ad8e9d16439ccd5e91924d2516bf9592975003f69beff44e56cddf47bd3118

生成StringToSign

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

HMAC计算得到的签名

*****

HTTP响应

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

结果为JSON格式，请参考以下示例。

• HTTP响应示例:

返回JSON字段说明：

textSpam:

tags:

subTags:

• 响应示例:

        {
           "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",
            "language": "English",
            "startTime": 1660103900367,
            "endTime": 1660103900374
        }

错误码