Zum Inhalt springen

pseudonymize.io API

Willkommen zur pseudonymize.io-Dokumentation. Stellen Sie diese API in den Pfad Ihrer sensiblen Daten, bevor sie externe Systeme (wie LLMs, Analytics Warehouses oder Support-Tools von Drittanbietern) erreichen.

Schnellstart

Senden Sie eine Anfrage an die Text-API, um Prosa zu pseudonymisieren.

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"
  }'

Antwort:

{
  "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" }
  ]
}

Authentifizierung

Alle API-Anfragen müssen Ihren API-Schlüssel im Header „Authorization“ enthalten.

Authorization: Bearer ps_live_...

API-Schlüssel werden im Format „ps_live_...“ generiert. Zu Ihrer Sicherheit wird der vollständige geheime Schlüssel bei der Erstellung nur einmal angezeigt. pseudonymize.io speichert API-Schlüssel niemals im Klartext – nur ein nicht umkehrbarer kryptografischer Hash (SHA-256) und ein kurzes identifizierendes Präfix (ps_live_XXXX) bleiben bestehen.

Sie können Ihre API-Schlüssel im Dashboard verwalten.

Text-API

„POST https://api.pseudonymize.io/text“ (auch verfügbar über „POST https://api.pseudonymize.io/v1/text“ und „/api/v1/text“)

Ersetzt Bezeichner in Prosa, ohne den Text um sie herum abzuflachen.

Anforderungstext

  • „text“ (Zeichenfolge, erforderlich): Der zu verarbeitende Text.
  • „Richtlinie“ (Zeichenfolge, optional): Die zu verwendende Richtlinie. Der Standardwert ist „default“.
  • „Erkennen“ (Array, optional): Spezifische zu erkennende Entitätstypen.
{
  "text": "Call me at +39 333 1234567.",
  "detect": ["PHONE"]
}

Strukturierte Daten-API

POST /api/v1/data

Pseudonymisieren Sie Bezeichnerfelder, während Zeilen und Schemata weiterhin verwendbar bleiben.

Anforderungstext

  • „Payload“ (Objekt | Array, erforderlich): Die zu verarbeitende JSON-Struktur (kann auch als „Daten“ übergeben werden).
  • „Richtlinie“ (Zeichenfolge, optional): Die zu verwendende Richtlinie. Der Standardwert ist „default“.
  • „Erkennen“ (Array, optional): Spezifische zu erkennende Entitätstypen.
{
  "payload": {
    "user": {
      "name": "Mario Rossi",
      "email": "[email protected]"
    }
  },
  "detect": ["PERSON", "EMAIL"]
}

Abrechnung und Kreditreservierung

Pseudonymize.io arbeitet nach einem transparenten Pay-as-you-go-Modell:

  • 1 € pro Million gemessener Token. Jede erfolgreiche Anfrage wird auf die nächsten 1.000 Token (1 Credit) aufgerundet; Mindestgebühr: 0,001 €.
  • Reservierung vor dem Flug: Credits werden atomar an der Gateway-Grenze reserviert, bevor Nutzlasten die Kernmaschine erreichen. Wenn ein Konto nicht über ausreichende Guthaben verfügt, gibt die API sofort „402 Zahlung erforderlich“ zurück, ohne Kundendaten weiterzuleiten.
  • Automatische Rückerstattungsgarantie: Wenn ein Upstream-Kernverarbeitungsaufruf fehlschlägt oder eine Zeitüberschreitung auftritt, werden reservierte Credits sofort vollständig zurückerstattet.

Pseudonyme und deterministische Identität

Pseudonymize.io nutzt die deterministische Identitätserhaltung innerhalb einer einzigen Anfrage. Wenn „Alice“ dreimal im selben Dokument vorkommt, wird sie alle drei Male zu „PERSON_01“. Dadurch können LLMs erkennen, dass es sich um dieselbe Person handelt, ohne zu wissen, wer es ist.

Fehler und Grenzen

Wir verwenden Standard-HTTP-Statuscodes.

  • „200 OK“: Erfolgreiche Verarbeitung.
  • „400 Bad Request“: Ungültiges oder fehlendes Nutzlastformat oder strukturierte Datentiefe über 32 Ebenen.
  • „401 Unauthorized“: Fehlender, ungültiger oder inaktiver API-Schlüssel.
  • „402 Zahlung erforderlich“: Nicht genügend Guthaben vorhanden. An der Gateway-Grenze blockiert.
  • „413 Payload Too Large“: Der Anforderungstext überschreitet 10 MB oder die Gesamtzahl der strukturierten Elemente überschreitet 50.000 Schlüssel.
  • „429 Too Many Requests“: Ratenlimit überschritten (60 Anforderungen/Min. pro API-Schlüssel, 120 Anforderungen/Min. pro Konto und IP). Der Header „Retry-After“ gibt an, wann es erneut versucht werden soll.
  • „502 Bad Gateway“: Kern-Engine nicht erreichbar oder Back-End-Verarbeitungsfehler. Credits werden automatisch zurückerstattet.
  • „504 Gateway Timeout“: Die Kern-Engine hat nicht innerhalb von 30 Sekunden geantwortet. Credits werden automatisch zurückerstattet.

Unterstützte Entitäten

  • „PERSON“ (Namen)
  • „ORGANISATION“ (Firmennamen)
  • „EMAIL“ (E-Mail-Adressen)
  • „PHONE“ (Telefonnummern)
  • „STANDORT“ (Städte, Adressen)
  • „IP“ (IPv4 und IPv6)
  • „IBAN“ (Bankkonten)
  • „KARTE“ (Kredit-/Debitkarten)

Sicherheit

  • Gateway-Abrechnungstabellen und strukturierte Anforderungsmetriken schließen API-Anforderungs- und Antworttexte aus. Konto-, Authentifizierungs-, Nutzungs-, Reservierungs- und Zahlungsmetadaten werden separat gespeichert; Durch das Löschen eines Kontos werden nicht alle Datensätze oder Sicherungen gelöscht.
  • Erfolgreiche Antworten mit einem Idempotency-Key werden für ein fünfminütiges Wiedergabefenster im Prozessspeicher gespeichert. Entitätsdetails können Originalidentifikatoren enthalten. Engine-, Proxy-, Swap-, Crash-Dump- und Backup-Kontrollen erfordern eine separate Überprüfung; Eine Festplattenpersistenz von Null ist in der gesamten Verarbeitungskette nicht garantiert.
  • Informationen zu Verarbeitungs- und Löschbeschränkungen finden Sie in der Datenschutzrichtlinie und auf der Seite Sicherheit.