假名.io API

欢迎使用psudonymize.io 文档。 在敏感数据到达外部系统（例如 LLM、分析仓库或第三方支持工具）之前，将此 API 放入敏感数据的路径中。

快速入门

向文本 API 发送请求以对散文进行假名化。

curl -X POST https://api.pseudonymize.io/text \
  -H "Authorization: Bearer ps_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Alice Rossi disputed invoice INV-204 from [email protected]",
    "policy": "default"
  }'

回复：

{
  "text": "PERSON_01 disputed invoice INV-204 from EMAIL_01",
  "entities": [
    { "type": "PERSON", "original": "Alice Rossi", "pseudonym": "PERSON_01" },
    { "type": "EMAIL", "original": "[email protected]", "pseudonym": "EMAIL_01" }
  ]
}

身份验证

所有 API 请求都必须在“Authorization”标头中包含您的 API 密钥。

Authorization: Bearer ps_live_...

API 密钥以“ps_live_...”格式生成。 为了您的安全，完整的密钥在创建时仅显示一次。 falsenymize.io 从不以明文形式存储 API 密钥，仅保留不可逆的加密哈希 (SHA-256) 和短识别前缀 (ps_live_XXXX)。

您可以在仪表板中管理您的API密钥。

文本API

POST https://api.pseudonymize.io/text （也可以通过 POST https://api.pseudonymize.io/v1/text 和 /api/v1/text 获得）

替换散文中的标识符，而不会使它们周围的文本变平。

请求正文

• text （字符串，必需）：要处理的文本。
• policy （字符串，可选）：要使用的策略。 默认为“默认”。
• detect （数组，可选）：要检测的特定实体类型。

{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

结构化数据 API

POST /api/v1/data

对标识符字段进行假名化，同时保持行和架构可用。

请求正文

• payload （对象 | 数组，必需）：要处理的 JSON 结构（也可以作为 data 传递）。
• policy （字符串，可选）：要使用的策略。 默认为“默认”。
• detect （数组，可选）：要检测的特定实体类型。

{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

账单和信用预订

Pseudonymize.io 采用透明的即用即付模式运营：

• 每百万计量令牌€1。每个成功请求按1,000令牌（1积分）向上取整，最低收费€0.001。
• 飞行前预留：在有效负载到达核心引擎之前，积分会自动保留在网关边界。 如果账户积分不足，API会立即返回“402需要付款”，不会转发客户数据。
• 自动退款保证：如果上游核心处理调用失败或超时，保留的积分将立即全额退款。

假名和确定性身份

Pseudonymize.io 在单个请求中使用确定性身份保留。 如果“Alice”在同一个文档中出现三次，则她三次都会变成“PERSON_01”。 这使得法学硕士能够明白这是“同一个人”，而不知道他是谁。

错误和限制

我们使用标准 HTTP 状态代码。

• 200 OK: 处理成功。
• 400 Bad Request：有效负载格式无效或丢失，或者结构化数据深度超过 32 层。
• 401 Unauthorized：API 密钥缺失、无效或不活动。
• 402 Payment required：剩余积分不足。 封锁在网关边界。
• 413 Payload Too Large：请求正文超过 10MB 或结构化元素总数超过 50,000 个键。
• 429 Too Many Requests：超出速率限制（每个 API 密钥 60 个请求/分钟，每个账户和 IP 120 个请求/分钟）。 “Retry-After”标头指示何时重试。
• 502 Bad Gateway：核心引擎无法访问或后端处理失败。 积分会自动退还。
• 504 Gateway Timeout: 核心引擎在30秒内没有响应。 积分会自动退还。

支持的实体

*“人”（姓名） *“组织”（公司名称） *“电子邮件”（电子邮件地址） *“电话”（电话号码）

• LOCATION（城市、地址） *“IP”（IPv4 和 IPv6）
• IBAN（银行账户） *“卡”（信用卡/借记卡）

安全

• 网关计费表和结构化请求指标不包括 API 请求和响应正文。 账户、认证、使用、预订和支付元数据单独保留； 帐户删除不会清除所有记录或备份。
• Idempotency-Key 的成功响应将保留在进程内存中，并有一个五分钟的重播窗口。 实体详细信息可能包含原始标识符。 引擎、代理、交换、故障转储和备份控制需要单独验证； 不保证整个处理链中的零磁盘持久性。
• 有关处理和删除限制，请参阅隐私政策和安全页面。