快速开始
几分钟内开始使用 API
- 1
安装 SDK:npm install @cloak-business/sdk 或 pip install cloak-business
- 2
从仪表板获取您的 API 令牌
- 3
进行您的第一个匿名化请求
- 4
集成到您的应用程序中
官方 SDK
JavaScript/TypeScript 和 Python 的类型安全库,支持零知识加密
JavaScript / TypeScript
npm install @cloak-business/sdk- 完整的 TypeScript 支持
- 客户端 AES-256-GCM 加密
- 指数退避的自动重试
- 适用于 Node.js 和浏览器
Python
pip install cloak-business- 完整的类型提示(PEP 484)
- 通过 cryptography 实现客户端加密
- 支持 aiohttp 的异步
- 兼容 Python 3.9+
API 功能
RESTful 端点
遵循 REST 最佳实践的清晰直观的 API 设计。
JWT 认证
所有 API 调用的安全令牌认证。
速率限制
公平的速率限制和清晰的头信息。企业用户享有更高限制。
官方 SDK
JavaScript/TypeScript 和 Python SDK,支持客户端加密。
可用端点
Asymmetric Key Management
常见问题
如何认证 API 请求?
在仪表板的设置 > API 密钥下生成一个 API 密钥。在每个请求中将其包含在 Authorization 头中,格式为 'Bearer YOUR_API_KEY'。
速率限制是多少?
速率限制取决于您的计划:免费(10 次请求/分钟)、基础(60 次请求/分钟)、专业(300 次请求/分钟)、企业(1,000 次请求/分钟)。当超过限制时,API 返回 HTTP 429 并带有 Retry-After 头。
支持批量处理吗?
支持。/api/v1/batch 端点每个请求最多处理 100 个文本。每个项目可以指定自己的语言和实体设置。结果包括每个项目的实体和聚合的元数据。
API 使用什么响应格式?
API 返回 JSON 响应,包含检测到的实体(类型、开始、结束、评分)、匿名化文本和处理元数据。完整的 OpenAPI 文档可在 /docs 查看。
如何获取 API 密钥?
在 cloak.business 注册一个免费账户,然后导航到设置 > API 密钥。您可以为不同的应用程序创建具有不同权限的多个密钥。
Explore Related Features
The API powers all cloak.business products. Explore how it integrates across platforms.
Chrome Extension
Anonymize AI prompts in ChatGPT, Claude, Gemini, and 3 more AI platforms before they leave your browser.
Reversible Encryption
Encrypt PII with AES-256-GCM and restore original data anytime with your key.
48-Language Detection
Detect PII in 48 languages with country-specific format support.
Is This Right for You?
Best For
- ✦Developers building privacy-first apps with programmatic PII anonymization
- ✦Automated pipelines — CI/CD, ETL jobs, and scheduled data processing
- ✦SaaS integrations that must sanitize user data before sending to third-party services
- ✦Teams with JavaScript or Python stacks using the official SDKs
- ✦Microservices architectures needing a dedicated anonymization endpoint
Not Ideal For
- ✦No-code or low-code teams — use the web app, Desktop App, or Office Add-in instead
- ✦Air-gapped environments with no internet access — use the Desktop App for offline processing
- ✦Very high-volume usage (>10M tokens/day) — contact sales for a dedicated tier
- ✦Ad-hoc one-off anonymization tasks — the web interface is faster for manual use