首页 开发文档 数据脱敏

数据脱敏

敏感数据脱敏:手机号、身份证、银行卡、邮箱、姓名打码,auto 模式自动识别文本中的各类数据,any 模式按自定义首尾保留位数脱敏。

请求信息
请求地址 https://cx4.cn/openApi/risk/mask 复制
请求方式 GET / POST
接口标识 risk_mask
鉴权方式 必须
四种方式任选其一:Header「X-Api-Key」/ Header「Authorization: Bearer 你的key」/ URL 参数「?key=你的key」/ POST 参数「key」
请求参数
参数名 类型 必填 说明 示例
text string 是 待脱敏文本 张三 13800138000
type string 否 auto 自动识别(默认)/ phone / idcard / bank / email / name / any auto
keep_start int 否 保留前几位,type=any 时生效 2
keep_end int 否 保留后几位,type=any 时生效 1
返回参数

下表字段位于返回结构的 data 内;外层 code / message 为全平台统一格式,不在此重复列出。

参数名 类型 说明 示例
original string 原始文本 张三 13800138000
masked string 脱敏结果 张三 138****8000
返回示例

成功

{
    "code": 200,
    "message": "操作成功",
    "data": {
        "ok": true,
        "type": "auto",
        "original": "张三 13800138000 test@example.com",
        "masked": "张三 138****8000 tes****@example.com"
    }
}

失败

{
    "code": 400,
    "message": "不支持的类型",
    "data": null
}
平台通用状态码
状态码 说明
200调用成功
400缺少必填参数或参数格式有误
401密钥缺失或无效
402余额不足,请充值后重试
403未开通该接口,请在本页开通后调用
404接口不存在或已下架
429触发限流,请稍后重试
500接口调用失败(已扣款的会自动退款)
调用示例

cURL 复制

curl -X POST "https://cx4.cn/openApi/risk/mask" -H "X-Api-Key: 你的SecretKey" -d "text=张三 13800138000&type=auto&keep_start=2&keep_end=1"

JavaScript 复制

fetch('https://cx4.cn/openApi/risk/mask', {
  method: 'POST',
  headers: {
    'X-Api-Key': '你的SecretKey',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: 'text=张三 13800138000&type=auto&keep_start=2&keep_end=1'
})
.then(res => res.json())
.then(data => console.log(data));

PHP 复制

post('https://cx4.cn/openApi/risk/mask', [
    'headers' => ['X-Api-Key' => '你的SecretKey'],
    'form_params' => ['text' => '张三 13800138000', 'type' => 'auto', 'keep_start' => '2', 'keep_end' => '1'],
]);
echo $response->getBody();

Java 复制

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://cx4.cn/openApi/risk/mask"))
    .header("X-Api-Key", "你的SecretKey")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .POST(HttpRequest.BodyPublishers.ofString("text=张三 13800138000&type=auto&keep_start=2&keep_end=1"))
    .build();
HttpResponse response = client.send(
        request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Python 复制

import requests

res = requests.post('https://cx4.cn/openApi/risk/mask',
    headers={'X-Api-Key': '你的SecretKey'},
    data={'text': '张三 13800138000', 'type': 'auto', 'keep_start': '2', 'keep_end': '1'})
print(res.json())
在线测试 (使用你的密钥真实调用,计费与正常调用一致)

登录后可在线测试: 立即登录

计费说明

¥0.0010

每次调用


每日免费额度:100 次

累计调用:9 次


快速上手

1. 注册并完成邮箱验证:立即注册

2. 登录后复制 Secret Key:去登录

3. 点击右侧「开通接口」按钮

4. 用下方「在线测试」一键体验,或复制下方示例代码直接调用