API文档(PII检测)
接口地址: | https://SLVdata.com/api/ |
返回格式: | JSON |
请求方式: | GET/POST |
请求Header:
名称 | 值 | 说明 |
---|---|---|
'content-type' | 'application/json' | 指定类型信息 |
'API-KEY' | 'API-KEY-XXXXXXXXX' | 你申请的API-KEY |
'ACCOUNT-ID' | '158XXX' | 你的账号 |
'PROCESS-MODE' | 'PRO-MD-103' | 数据处理方式,编码'PRO-MD-103'代表PII检测 |
'RETURN-PATTERN' | 'P' | 数据返回样式, P:只返回PII位置信息 MF:返回脱敏后的文本(全替换方式,如手机号:***********) MP:返回脱敏后的文本(部分替换方式,如手机号:1378*******) |
'MASK-ITEMS' | 'PHONE', 'EMAIL', 'PERSON', 'ID', 'LOCATION', 'BANK_ACCOUNT', 'IP' |
当'RETURN-PATTERN'设置了需要脱敏返回时,即设定为'MF'或'MP'时,需要设定MASK-ITEMS变量,根据自己需要,指定需要脱敏的项目,可一个或多个(默认不填将对所有项目脱敏)。 每个项目用英文单引号包围,项目间用英文逗号分割,最外层用英文双引号包围, 比如只对'电话'及'身份证号'脱敏,可以这样设置"'PHONE','ID'" 'PHONE' 表示电话 'EMAIL' 表示邮箱地址 'PERSON' 表示人名 'ID' 表示身份证号 'LOCATION' 表示地址信息 'BANK_ACCOUNT' 表示银行账号 'IP' 表示IP地址 |
请求的数据格式:
// 请求处理的数据,字典格式, // 第1列为编号,这里时固定值,不用更改 // 第2列为具体的文本数据内容,最大支持8000字符 data = { '1': '你好,请通过电话或邮件方式联系我,我的手机号码是13888888888,邮箱是MaSke_3568@hotmal.com,我身份证号是310302198202186091,有任何问题联系我,......' } |
注意:文本数据内容最大支持8000字符,超过部分将会被截断
返回的数据格式(数据返回样式为'RETURN-PATTERN'='P'时的格式):
response_text = { 'message_code': 2000, // API返回码 'data': { '1': "[{'type': 'EMAIL', 'start_char': 39, 'end_char': 60, 'text': MaSke_3568@hotmal.com'}, {'type': 'ID', 'start_char': 67, 'end_char': 85, 'text': '310302198202186091'}, {'type': 'PHONE', 'start_char': 24, 'end_char': 35, 'text': '13888888888'},]" } } |
返回的数据格式(数据返回样式为'RETURN-PATTERN'='MF', 'MASK-ITEMS'="'PHONE','EMAIL','ID'"时的格式):
response_text = { 'message_code': 2000, // API返回码 'data': { '1': '你好,请通过电话或邮件方式联系我,我的手机号码是***********,邮箱是*********************,我身份证号是******************,有任何问题联系我,......' } } |
返回的数据格式(数据返回样式为'RETURN-PATTERN'='MP', 'MASK-ITEMS'="'PHONE','EMAIL','ID'"时的格式):
response_text = { 'message_code': 2000, // API返回码 'data': { '1': '你好,请通过电话或邮件方式联系我,我的手机号码是1388*******,邮箱是MaSk*****************,我身份证号是3103**************,有任何问题联系我,......' } } |