数据脱敏
数据脱敏:手机号、身份证、姓名、邮箱掩码,支持整段文本自动识别
数据脱敏:对文本或字段中的手机号、身份证、姓名、邮箱做掩码处理。
适合日志导出、报表展示、后台数据看板等场景,避免明文泄露隐私。
适合日志导出、报表展示、后台数据看板等场景,避免明文泄露隐私。
调用地址:https://api.ynlskj.com.cn/gateway/datamask
请求方法:POST
在其他地方怎么调用
- 请求地址用上面的调用地址,把 JSON 放在请求体里
- 方法用
POST - API Key 只能放在请求头
X-API-Key,不要写进网址,也不要写进 Query 框 - Key 在「个人中心 → API Key」里复制,登录后会自动填入你自己的 Key
参数说明
| 参数 | 位置 | 必填 | 说明 |
|---|---|---|---|
text | Body JSON | 文本脱敏时 | 待脱敏整段文本。也可用 content |
fields | Body JSON | 字段脱敏时 | 对象,如 {"phone":"13812345678","name":"张三"} |
action | Body JSON | 否 | 默认 mask 自动识别;也可 phone / idcard / name / email 单项脱敏 |
value | Body JSON | 单项脱敏时 | 待脱敏的单个值 |
types | Body JSON | 否 | 限定识别类型,如 ["phone","idcard"],默认全部 |
X-API-Key | Header | 是 | 你的 API Key |
脱敏规则
| 类型 | 规则 | 示例 |
|---|---|---|
| 手机号 | 保留前 3 位 + 后 4 位 | 138****5678 |
| 身份证 | 保留前 6 位 + 后 4 位 | 530102********1234 |
| 姓名 | 2 字留首字;3 字及以上留首尾 | 张*、欧**娜 |
| 邮箱 | 本地部分掩码,域名保留 | zha****@example.com |
请求示例
| 场景 | Body 示例 |
|---|---|
| 整段文本自动识别 | {"text":"联系人张三,手机13812345678,身份证530102199001011234"} |
| 结构化字段 | {"fields":{"phone":"13812345678","name":"张三","email":"a@b.com"}} |
| 单项脱敏 | {"action":"phone","value":"13812345678"} |
| 只脱敏手机号和身份证 | {"text":"...","types":["phone","idcard"]} |
姓名自动识别依赖上下文关键词(如「联系人」「姓名」)。纯姓名单独出现时建议用 fields 或 action=name。
返回说明
| 字段 | 说明 |
|---|---|
ret | ok 成功,err 失败 |
data.text | 脱敏后的整段文本(action=mask 时) |
data.fields | 脱敏后的字段对象(传入 fields 时) |
data.masked / result | 单项脱敏结果(action=phone 等时) |
data.hits | 命中列表:[{type, original, masked}, ...] |
data.count / counts | 脱敏命中总数 / 按类型统计 |
msg | 本站提示,如「次数充足,剩余 99 次」或「次数不足,剩余 0 次」 |
remain_quota | 本次调用后的剩余次数 |
可直接复制的代码
未登录时示例只显示「你的密钥」。登录后会自动填入你自己的 Key,不会展示别人的。
<?php
$ch = curl_init('https://api.ynlskj.com.cn/gateway/datamask');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ['X-API-Key: 你的密钥', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{
"text": "联系人张三,手机13812345678,身份证530102199001011234,邮箱zhangsan@example.com"
}',
]);
echo curl_exec($ch);
请求参数演示
{"text":"联系人张三,手机13812345678,身份证530102199001011234,邮箱zhangsan@example.com"}
响应演示
{"ret":"ok","data":{"action":"mask","text":"联系人张*,手机138****5678,身份证530102********1234,邮箱zha****@example.com","count":4,"counts":{"phone":1,"idcard":1,"name":1,"email":1}}}