# 暴恐敏感信息过滤 API 文档

# 接口说明

暴恐敏感信息过滤，用于分析图片是否包含以下暴恐敏感信息（武器类，军警服饰类，宗教服饰类，旗帜类，国家标志类，台标类）。
该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成暴恐敏感信息过滤API时，需按照以下要求。

# 接口调用流程

注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。

1. 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
2. 将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
3. 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。

接口地址示例：

	POST http[s]://api.xfyun.cn/v1/service/v1/image_identify/terror_filter HTTP/1.1
	Content-Type:application/x-www-form-urlencoded; charset=utf-8

# 白名单

在调用该业务接口时

• 若关闭IP白名单，接口认为IP不限，不会校验IP。
• 若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。

IP白名单规则

• IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
• 不同Appid的不同服务都需要分别设置IP白名单；
• IP白名单需设置为外网IP，请勿设置局域网IP。
• 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。

{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

在 Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置；
  
• X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效；
  
• BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。
  

*X-CheckSum *生成示例：

String APIKey="abcd1234"; 
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);

# 业务参数

X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串，原始 JSON 串各字段说明如下：

# 请求体

以POST表单的形式提交以下参数：

注：
一般基础类库会默认进行urlencode处理，请注意不要重复处理。

# 接口返回参数

返回值为 json 串，各字段如下：

其中 sid 字段主要用于追查问题，如果出现问题，可以提供 sid 给讯飞技术人员帮助确认问题。

data中结果字段说明：

categories结果说明：

示例如下：

失败：

    {
        "code": "10106",
        "desc": "invalid parameter|invalid X-Appid",
        "data": {},
        "sid": "wsr0000bb3f@dx3d5c059d83b3477200"
    }

成功（单张图片）：

	{
    "data":{
        "image_id":"c0c616eba10542fab5815d828d74aa22",
        "type":2,
        "confidence":0.8290718197822571,
        "categories":[
            {
                "type":2,
                "confidence":0.8290718197822571
            },
            {
                "type":1,
                "confidence":0.5321321313123212
            }
        ]
    },
    "code":"0",
    "desc":"success",
    "sid":"wsr00000001@ll36940e324c59000100"
	}

成功（多张图片）：

	{
    "data":{
        "type":1,
        "confidence":0.7573663592338562,
        "details":[
            {
                "image_id":"ee93d40ad0a54ab6a78ced96daf75bcf",
                "type":1,
                "confidence":0.7573663592338562,
                "categories":[
                    {
                        "type":1,
                        "confidence":0.7573663592338562
                    }
                ],
                "image_name":"sample9.jpg"
            },
            {
                "image_id":"ee93d40ad0a54ab6a78ced96daf75bc0",
                "type":0,
                "confidence":0,
                "categories":[
                    {
                        "type":0,
                        "confidence":0
                    }
                ],
                "image_name":"sample8.jpg"
            }
        ]
    },
    "code":"0",
    "desc":"success",
    "sid":"wsr00000001@ll36940e324c59000100"
	}

# 调用示例

暴恐敏感信息过滤demo go语言

暴恐敏感信息过滤demo php语言

暴恐敏感信息过滤demo java语言

暴恐敏感信息过滤demo python语言

暴恐敏感信息过滤demo c#语言

暴恐敏感信息过滤demo nodejs语言

# 常见问题

# 暴恐敏感信息过滤的主要功能是什么？

答：快速分析图片中的暴恐敏感信息，包含：武器、军警服饰、宗教服饰、旗帜类、国家标志类、台标类。

# 暴恐敏感信息过滤对上传的图片有什么要求？

答：支持的文件类型包括：静态图片或图片压缩包(jpg, jpeg, bmp, png大小不超过10M，zip大小不超过50M)

# 暴恐敏感信息过滤支持哪些应用平台？

答：目前暴恐敏感信息过滤支持WebAPI应用平台。

# 暴恐敏感信息过滤是否支持纯文字敏感词过滤？

答：不支持，目前暴恐敏感信息过滤只支持对图片内容进行暴恐敏感信息过滤审核。

# 暴恐敏感信息过滤可以免费使用吗？

答：可以的，登录讯飞开放平台---控制台---我的应用（没有应用先创建一个应用）---内容审核---暴恐敏感信息过滤（可免费调用Webapi接口共500次服务量，授权期限1个月）。