数据脱敏（敏感信息掩码） API 接入文档desensitize

自动检测并脱敏文本中的手机号、身份证（15/18 位）、银行卡（16-19 位）、邮箱、中文姓名等敏感信息。支持按类型组合，纯本地正则匹配，毫秒级返回。默认不回显原文，避免日志泄漏。

1. 基本信息

接口地址	`https://v1.apizero.cn/api/desensitize`
请求方法	`POST`
分类	content
提供方	极数本源
计费模式	免费试用
单次消耗	0 积分
起步价	—
QPS 限制	10 req/s
每日免费额度	200 次（已认证用户）
匿名每日额度	50 次（无 API Key）
VIP 免费	否
调用次数

2. 认证

匿名免登录可调，每日 50 次；登录用户每日 200 次。

获取 API Key：登录 https://apizero.cn/account/keys

3. 请求参数

参数名	类型	必填	说明	示例
`text`	`string`	是	要脱敏的文本，最长 50000 字节	—
`types`	`string`	否	类型逗号分隔：phone,idcard,bankcard,email,name 或 all（默认）	—
`with_original`	`bool`	否	是否在 detections 中回显原文，默认 false	—

5. 请求示例

以下 5 种语言示例都是可直接运行的，只需把 YOUR_API_KEY 替换为实际 Key。

cURL

curl -X POST "https://v1.apizero.cn/api/desensitize" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "<text>",
  "types": "<types>",
  "with_original": "<with_original>"
}'

Python

import requests

resp = requests.request(
    "POST",
    "https://v1.apizero.cn/api/desensitize",
    headers={"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json={
    "text": "<text>",
    "types": "<types>",
    "with_original": "<with_original>",
},
    timeout=15,
)
resp.raise_for_status()
print(resp.json())

JavaScript (Node.js)

// Node.js 18+ / 浏览器原生 fetch
const res = await fetch("https://v1.apizero.cn/api/desensitize", {
  method: "POST",
  headers: {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "text": "<text>",
    "types": "<types>",
    "with_original": "<with_original>"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const data = await res.json();
console.log(data);

Go

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body := []byte(`{"text":"<text>","types":"<types>","with_original":"<with_original>"}`)
	req, _ := http.NewRequest("POST", "https://v1.apizero.cn/api/desensitize", bytes.NewBuffer(body))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(string(out))
}

PHP

<?php
$payload = json_encode([
    "text" => "<text>",
    "types" => "<types>",
    "with_original" => "<with_original>",
], JSON_UNESCAPED_UNICODE);

$ch = curl_init("https://v1.apizero.cn/api/desensitize");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => "POST",
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_HTTPHEADER     => [
        "X-Api-Key: YOUR_API_KEY",
        "Content-Type: application/json",
    ],
    CURLOPT_TIMEOUT        => 15,
]);
$body = curl_exec($ch);
curl_close($ch);

$data = json_decode($body, true);
print_r($data);

6. 响应字段

字段	类型	说明	示例
`masked_text`	`string`	脱敏后的完整文本	—
`detection_count`	`number`	识别到的敏感信息数量（去重）	—
`summary`	`object`	按类型分组的命中数量	—
`detections`	`array`	每条命中明细 {type, masked, [original]}	—
`types_applied`	`array`	本次应用的脱敏类型列表	—

7. 响应示例

{
    "code": 0,
    "msg": "成功",
    "data": {
        "masked_text": "联系人：张*，电话 138****8000",
        "detection_count": 2,
        "summary": {
            "name": 1,
            "phone": 1
        },
        "detections": [
            {
                "type": "name",
                "masked": "张*"
            },
            {
                "type": "phone",
                "masked": "138****8000"
            }
        ],
        "types_applied": [
            "phone",
            "idcard",
            "bankcard",
            "email",
            "name"
        ]
    }
}

8. 错误码

code	status	说明
`4000`	`—`	text 为空或超长，或 types 不包含任何有效类型

9. 变更日志

1.0.0(2026-05-07)
- 首次上线 · 5 类敏感信息识别

常见问题

数据脱敏（敏感信息掩码）接口怎么免费使用？

未登录用户每个 IP 每天 50 次免费。登录用户创建 API Key 后每天 200 次免费，超额部分按点数计费（0 点/次）。

数据脱敏（敏感信息掩码）支持哪些调用方式？

接口使用 POST 请求。文档提供 cURL、Python、JavaScript (Node.js)、Go、PHP 五种语言的可运行示例。也可以下载 /openapi.json 导入 Postman / Insomnia / Apifox 反向生成 SDK。

调用不限额么？ QPS 是多少？

本接口 QPS 限制 10 req/s，每个 API Key 每日免费 200 次。需要更高额度可升级 VIP 套餐或联系售后提高 QPS。

这个接口跟自己直连上游有什么区别？

极数本源作为中间层提供：统一鉴权（一个 Key 调所有接口）、统一计费（点数制）、统一限流、统一错误码、多上游自动切换。免去逐个对接上游、维护 Key、统计调用量的运维成本。