APIリファレンス
アプリケーションに匿名化を統合
プログラムによるPII検出と匿名化のための完全なREST API。
ベースURL
https://anonymize.today/apiすべてのAPIエンドポイントはこのベースURLに対して相対的です。例えば、分析エンドポイントは https://anonymize.today/api/presidio/analyze.
認証
Bearerトークンを使用してAPIリクエストを認証します:
Authorization: Bearer YOUR_API_TOKENAPIトークンの取得
- anonymize.todayアカウントにサインインします
- 設定 → アカウント → APIトークンに移動します
- 新しいトークンを生成をクリックします
- トークンをコピーして安全に保管します（再表示されません）
セキュリティノート
クライアント側のコードや公開リポジトリでAPIトークンを公開しないでください。環境変数とサーバー側のリクエストを使用してください。
リクエスト内のトークン
TypeScript
const response = await fetch('https://anonymize.today/api/presidio/analyze', {
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.ANONYMIZE_API_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ text, entities }),
});Python
import os
import requests
headers = {
"Authorization": f"Bearer {os.environ['ANONYMIZE_API_TOKEN']}",
"Content-Type": "application/json"
}
response = requests.post(
"https://anonymize.today/api/presidio/analyze",
headers=headers,
json={"text": text, "entities": entities}
)cURL
curl -X POST https://anonymize.today/api/presidio/analyze \
-H "Authorization: Bearer $ANONYMIZE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"text": "John Doe works at Acme Corp", "entities": ["PERSON", "ORGANIZATION"]}'レート制限
| エンドポイントタイプ | レート制限 | バースト許可: 10リクエスト |
|---|---|---|
| Authentication | 3 requests/second | 5 requests |
| Analysis & Anonymization | 30 requests/second | 50 requests |
| Presets & Settings | 10 requests/second | 20 requests |
レート制限がかかると、APIは429 Too Many Requestsを返し、リトライ可能な時間を示すRetry-Afterヘッダーが含まれます。
コアエンドポイント
テキストの分析
テキスト内のPIIエンティティを検出します。検出されたエンティティの位置とタイプを返します。
テキストの匿名化
さまざまなオペレーターを使用して検出されたPIIエンティティを匿名化します。
テキストの非匿名化
同じ暗号化キーを使用して暗号化されたエンティティを元の値に復元します。
匿名化オペレーター
| オペレーター | 説明 | 可逆 | 例 |
|---|---|---|---|
| replace | プレースホルダーで置き換え | No | John → [PERSON] |
| mask | 部分的に文字をマスク | No | john@email.com → j***@email.com |
| redact | 完全に削除 | No | John → (empty) |
| hash | 一方向SHA-256ハッシュ | No | John → a3f2b1c4... |
| encrypt | AES-256-GCM暗号化 | Yes | John → [ENC:...] |
オペレーター設定
// Replace operator
{ "type": "replace", "new_value": "[PERSON]" }
// Mask operator
{
"type": "mask",
"masking_char": "*",
"chars_to_mask": 5,
"from_end": false
}
// Hash operator
{ "type": "hash", "hash_type": "sha256" }
// Encrypt operator (requires encryption key in user settings)
{ "type": "encrypt" }
// Redact operator
{ "type": "redact" }プリセットAPI
エンティティタイプ
anonymize.todayは10カテゴリにわたって256のエンティティタイプをサポートしています：
Personal
PERSON, EMAIL_ADDRESS, PHONE_NUMBER
Financial
CREDIT_CARD, IBAN_CODE, SWIFT_CODE, CRYPTO
Location
LOCATION, ADDRESS, COORDINATES
Government
SSN, PASSPORT, DRIVER_LICENSE, NATIONAL_ID
Contact
URL, DOMAIN_NAME
Technical
IP_ADDRESS, MAC_ADDRESS
Temporal
DATE_TIME, AGE
Organizational
ORGANIZATION, JOB_TITLE
Medical
MEDICAL_LICENSE, HEALTH_ID
Custom
User-defined patterns
プリセットドキュメントでエンティティタイプの完全なリストを確認してください。 Presets documentation.
サポートされている言語
APIはPII認識のために27の言語をサポートしています：
| コード | 言語 | エンジン |
|---|---|---|
| en | English | spaCy |
| de | German | spaCy |
| es | Spanish | spaCy |
| fr | French | spaCy |
| it | Italian | spaCy |
| pt | Portuguese | spaCy |
| nl | Dutch | spaCy |
| pl | Polish | spaCy |
| ru | Russian | spaCy |
| ja | Japanese | spaCy |
| zh | Chinese | spaCy |
| ko | Korean | spaCy |
| ar | Arabic | Transformer |
| hi | Hindi | Transformer |
| tr | Turkish | Transformer |
追加の言語：ルーマニア語、ギリシャ語、クロアチア語、スロベニア語、マケドニア語、スウェーデン語、デンマーク語、ノルウェー語、フィンランド語、ウクライナ語、リトアニア語、カタルーニャ語
エラー処理
標準HTTPステータスコード:
| ステータス | 意味 | 説明 |
|---|---|---|
| 200 | OK | Request succeeded |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | 400 - 不正リクエスト（無効なパラメータ） |
| 401 | Unauthorized | 401 - 認証エラー（無効または欠落したトークン） |
| 402 | Payment Required | Insufficient tokens |
| 403 | Forbidden | Access denied to resource |
| 404 | Not Found | Resource not found |
| 429 | Too Many Requests | 429 - レート制限（リクエストが多すぎる） |
| 500 | Internal Error | 500 - サーバーエラー（サポートに連絡） |
エラー応答形式
{
"error": {
"code": "INSUFFICIENT_TOKENS",
"message": "You need 5 tokens but only have 2 remaining",
"details": {
"required": 5,
"available": 2
}
}
}完全な例
TypeScript/Node.js
import fetch from 'node-fetch';
const API_BASE = 'https://anonymize.today/api';
const API_TOKEN = process.env.ANONYMIZE_API_TOKEN;
async function analyzeAndAnonymize(text: string) {
// Step 1: Analyze
const analyzeResponse = await fetch(`${API_BASE}/presidio/analyze`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
text,
entities: ['PERSON', 'EMAIL_ADDRESS', 'PHONE_NUMBER'],
language: 'en',
}),
});
const { results } = await analyzeResponse.json();
if (results.length === 0) {
return { text, anonymized: false };
}
// Step 2: Anonymize
const anonymizeResponse = await fetch(`${API_BASE}/presidio/anonymize`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
text,
analyzer_results: results,
anonymizers: {
DEFAULT: { type: 'replace', new_value: '[REDACTED]' },
},
}),
});
return anonymizeResponse.json();
}
// Usage
const result = await analyzeAndAnonymize('Contact John Doe at john@example.com');
console.log(result.text); // "Contact [REDACTED] at [REDACTED]"
Python
import os
import requests
API_BASE = "https://anonymize.today/api"
API_TOKEN = os.environ["ANONYMIZE_API_TOKEN"]
def analyze_and_anonymize(text: str) -> dict:
headers = {
"Authorization": f"Bearer {API_TOKEN}",
"Content-Type": "application/json"
}
# Step 1: Analyze
analyze_response = requests.post(
f"{API_BASE}/presidio/analyze",
headers=headers,
json={
"text": text,
"entities": ["PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER"],
"language": "en"
}
)
results = analyze_response.json()["results"]
if not results:
return {"text": text, "anonymized": False}
# Step 2: Anonymize
anonymize_response = requests.post(
f"{API_BASE}/presidio/anonymize",
headers=headers,
json={
"text": text,
"analyzer_results": results,
"anonymizers": {
"DEFAULT": {"type": "replace", "new_value": "[REDACTED]"}
}
}
)
return anonymize_response.json()
# Usage
result = analyze_and_anonymize("Contact John Doe at john@example.com")
print(result["text"]) # "Contact [REDACTED] at [REDACTED]"
Related Documentation
最終更新日: 2026年3月