Entwickler-Dokumentation

Ainonyme erkennt und anonymisiert personenbezogene Daten in Texten – DSGVO-konform, in Echtzeit und mit Hosting in Deutschland. Diese Seite erklärt, wie du die API in deine Anwendung integrierst.


So funktioniert Ainonyme

  1. Text senden – Du schickst einen Text an die API.
  2. Erkennung – Ainonyme erkennt automatisch sensible Daten wie E-Mail-Adressen, Telefonnummern, Adressen, IBANs, Namen, Kreditkartennummern und medizinische Begriffe.
  3. Anonymisierung – Erkannte Daten werden durch Platzhalter ersetzt, z. B. [[EMAIL_1]], [[PHONE_1]].
  4. Wiederherstellung – Mit der zurückgegebenen map_id kannst du den Originaltext jederzeit wiederherstellen.

Authentifizierung

Alle API-Aufrufe erfordern einen gültigen API-Key im Header:

X-API-KEY: dein-api-key

Deinen API-Key findest du nach dem Login unter Einstellungen → API.

Endpunkte

Text anonymisieren

POST /api/v1/privacy/anonymize
Content-Type: application/json

{
  "text": "Kontaktiere Max Mustermann unter max@example.com",
  "mode": "standard"
}

Antwort:

{
  "text": "Kontaktiere [[NAME_1]] unter [[EMAIL_1]]",
  "entities": [
    { "original": "Max Mustermann", "replacement": "[[NAME_1]]" },
    { "original": "max@example.com", "replacement": "[[EMAIL_1]]" }
  ],
  "map_id": "map_abc123",
  "applied_rules": ["NAME", "EMAIL"],
  "stats": {
    "entities_found": 2,
    "processing_ms": 12
  }
}

Text wiederherstellen

POST /api/v1/privacy/deanonymize
Content-Type: application/json

{
  "text": "Kontaktiere [[NAME_1]] unter [[EMAIL_1]]",
  "map_id": "map_abc123"
}

Antwort:

{
  "text": "Kontaktiere Max Mustermann unter max@example.com",
  "map_id": "map_abc123",
  "applied_rules": ["NAME", "EMAIL"]
}

Optionale Parameter

Parameter Typ Beschreibung
mode string standard (alle Regeln) oder minimal (nur E-Mail, Telefon, IBAN, Kreditkarte)
categories array Nur bestimmte Kategorien anwenden, z. B. ["EMAIL", "PHONE"]
whitelist array Begriffe, die nicht anonymisiert werden sollen

Erkannte Kategorien

Kategorie Beispiel Platzhalter
EMAILmax@example.com[[EMAIL_1]]
PHONE+49 176 1234567[[PHONE_1]]
ADDRESSParkstraße 5, 10115 Berlin[[ADDRESS_1]]
IBANDE89 3704 0044 0532 0130 00[[IBAN_1]]
CARD4111 1111 1111 1111[[CARD_1]]
NAMEMax Mustermann[[NAME_1]]
MEDICALBluthochdruck[[MEDICAL_1]]
FINANCEKreditvertrag, Zinssatz[[FINANCE_1]]

Quickstart mit cURL

curl -X POST https://ainony.me/api/v1/privacy/anonymize \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: DEIN_KEY" \
  -d '{"text": "Sende die Rechnung an Max Mustermann, max@example.com"}'

Fehlercodes

Code Bedeutung
401API-Key fehlt oder ist ungültig
422Validierungsfehler (z. B. Text fehlt oder zu lang)
429Rate-Limit überschritten (max. 120 Anfragen/Minute)
500Interner Fehler – der Originaltext wird als Fallback zurückgegeben

Limits

  • Maximale Textlänge: 20.000 Zeichen
  • Rate-Limit: 120 Anfragen pro Minute

Fragen? Schreib uns an mail@ainony.me.