API-Referenz
Integrieren Sie Anonymisierung in Ihre Anwendungen
Vollständige REST-API für programmgesteuerte PII-Erkennung und Anonymisierung.
Basis-URL
https://anonymize.today/apiAlle API-Endpunkte sind relativ zu dieser Basis-URL. Zum Beispiel ist der Analyse-Endpunkt https://anonymize.today/api/presidio/analyze.
Authentifizierung
Authentifizieren Sie API-Anfragen mit Bearer-Token:
Authorization: Bearer YOUR_API_TOKENAPI-Token abrufen
- Melden Sie sich bei Ihrem anonymize.today-Konto an
- Gehen Sie zu Einstellungen → Konto → API-Token
- Klicken Sie auf Neues Token generieren
- Kopieren Sie Ihr Token und speichern Sie es sicher (es wird nicht erneut angezeigt)
Sicherheitsnotiz
Setzen Sie Ihr API-Token niemals in clientseitigem Code oder öffentlichen Repositories aus. Verwenden Sie Umgebungsvariablen und serverseitige Anfragen.
Token in Anfragen
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"]}'Rate Limits
| Endpunkt-Typ | Rate-Limit | Burst-Zulassung: 10 Anfragen |
|---|---|---|
| Authentication | 3 requests/second | 5 requests |
| Analysis & Anonymization | 30 requests/second | 50 requests |
| Presets & Settings | 10 requests/second | 20 requests |
Bei Erreichung des Rate-Limits gibt die API 429 Zu viele Anfragen mit einem Retry-After-Header zurück, der angibt, wann Sie es erneut versuchen können.
Kern-Endpunkte
Text analysieren
PII-Entitäten im Text erkennen. Gibt Positionen und Typen der erkannten Entitäten zurück.
Text anonymisieren
Erkannte PII-Entitäten mit verschiedenen Operatoren anonymisieren.
Text deanonymisieren
Verschlüsselte Entitäten mit demselben Verschlüsselungsschlüssel in ihre ursprünglichen Werte zurücksetzen.
Anonymisierungsoperatoren
| Operator | Beschreibung | Umkehrbar | Beispiel |
|---|---|---|---|
| replace | Mit Platzhalter ersetzen | No | John → [PERSON] |
| mask | Zeichen teilweise maskieren | No | john@email.com → j***@email.com |
| redact | Vollständig entfernen | No | John → (empty) |
| hash | Einweg-SHA-256-Hash | No | John → a3f2b1c4... |
| encrypt | AES-256-GCM-Verschlüsselung | Yes | John → [ENC:...] |
Operator-Konfigurationen
// 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" }Voreinstellungen API
Entitätstypen
anonymize.today unterstützt 256 Entitätstypen in 10 Kategorien:
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
Sehen Sie die vollständige Liste der Entitätstypen in der Dokumentation zu Voreinstellungen. Presets documentation.
Unterstützte Sprachen
Die API unterstützt 27 Sprachen zur PII-Erkennung:
| Code | Sprache | Engine |
|---|---|---|
| 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 |
Zusätzliche Sprachen: Rumänisch, Griechisch, Kroatisch, Slowenisch, Mazedonisch, Schwedisch, Dänisch, Norwegisch, Finnisch, Ukrainisch, Litauisch, Katalanisch
Fehlerbehandlung
Standard-HTTP-Statuscodes:
| Status | Bedeutung | Beschreibung |
|---|---|---|
| 200 | OK | Request succeeded |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | 400 - Ungültige Anfrage (ungültige Parameter) |
| 401 | Unauthorized | 401 - Unbefugter Zugriff (ungültiges oder fehlendes Token) |
| 402 | Payment Required | Insufficient tokens |
| 403 | Forbidden | Access denied to resource |
| 404 | Not Found | Resource not found |
| 429 | Too Many Requests | 429 - Rate Limitiert (zu viele Anfragen) |
| 500 | Internal Error | 500 - Serverfehler (Support kontaktieren) |
Fehlerantwortformat
{
"error": {
"code": "INSUFFICIENT_TOKENS",
"message": "You need 5 tokens but only have 2 remaining",
"details": {
"required": 5,
"available": 2
}
}
}Vollständige Beispiele
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
Zuletzt aktualisiert: März 2026