Para integradores e IT de despachos
Automatizar Datenmaske Secure.
Cuatro interfaces, un principio: todo se ejecuta en el mismo equipo que la aplicación. El servidor API solo escucha en 127.0.0.1 — ningún byte del documento cruza una tarjeta de red.
El pipeline tras la API es idéntico al de la interfaz: misma detección, misma verificación fail-closed, mismo control de restos tras exportar.
- 100 % en el equipo
- API solo en 127.0.0.1
- Sin subidas, sin nube
- § 203 StGB: el documento nunca sale de la máquina
Cuatro vías de integración
API REST (local)
Detectar y tachar por HTTP en 127.0.0.1 — para scripts en el mismo equipo.
Carpeta vigilada
Vigila una carpeta: cada archivo nuevo pasa a revisión — o, en modo «Auto», directamente a un export fail-closed.
Menú contextual del Explorador
Clic derecho en un PDF → «Schwärzen mit Datenmaske».
MSI + GPO
Despliegue por directiva de grupo o Intune; ajustes centrales de actualizaciones, modelos y carpeta vigilada.
Requisitos
- Datenmaske Secure instalado y en ejecución (la API y la carpeta solo funcionan con la app abierta; minimizada en la bandeja sirve).
- Licencia activa — sin contexto de usuario, la carpeta vigilada no procesa nada a propósito.
- Para scripts: Windows con curl.exe (incluido desde Windows 10) o PowerShell 5.1+.
Activar la API REST
La API viene apagada. Se activa en Ajustes, por puesto; la clave la elige usted (no se genera) y queda solo en la aplicación.
- Ajustes → Sistema → «API REST local».
- Introducir puerto (47190 por defecto) y una clave API a su elección. Sin clave, el servidor no arranca (fail-closed).
- Pulsar «Iniciar». El estado pasa a activo y la API responde.
- Desde el siguiente arranque, la API se inicia sola mientras haya clave y esté activada.
Primera petición (health)
curl.exe
curl.exe http://127.0.0.1:47190/api/v1/health PowerShell
Invoke-RestMethod http://127.0.0.1:47190/api/v1/health → {"status":"ok"} (no key required — liveness only, no document data)
Detectar: POST /api/v1/detect
La petición lleva el PDF en Base64. La respuesta lista cada hallazgo con página, coordenadas de caja (puntos PDF, origen arriba a la izquierda), tipo, confianza y fuente (regex/modelo). Esas cajas son las que se pasan al tachado.
PowerShell
$key = "MEIN-SCHLUESSEL"
$pdf = [Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\Akten\gutachten.pdf"))
$det = Invoke-RestMethod -Method Post -Uri http://127.0.0.1:47190/api/v1/detect -Headers @{ Authorization = "Bearer $key" } -ContentType "application/json" -Body (@{ pdfB64 = $pdf } | ConvertTo-Json)
$det.suggestions | Select-Object pageNumber, sensitivityType, confidence, source | suggestions[].pageNumber | Página, desde 1 |
| suggestions[].bboxX / bboxY / bboxWidth / bboxHeight | Caja en puntos PDF |
| suggestions[].sensitivityType | p. ej. name, iban, birth_date |
| suggestions[].confidence | 0–99 |
| suggestions[].source | regex (reglas/checksums) o ner (modelo) |
Tachar: POST /api/v1/redact
Las cajas de detección se agrupan por página. La respuesta devuelve el PDF tachado (Base64) y un informe; report.outputUsable es la señal de confianza: false significa que la verificación encontró un resto y el archivo se descartó.
! Sin revisión humana: el script solo tacha lo que la detección encuentra. outputUsable confirma la eliminación, no la exhaustividad. En expedientes con nombres, texto libre o escaneos: revisar por muestreo o usar la carpeta vigilada en modo «Revisión».
PowerShell
# Boxen aus $det nach Seite gruppieren und schwärzen
$pages = $det.suggestions | Group-Object pageNumber | ForEach-Object {
@{
pageNumber = [int]$_.Name
rects = $_.Group | ForEach-Object {
@{ x = $_.bboxX; y = $_.bboxY; width = $_.bboxWidth; height = $_.bboxHeight }
}
}
}
$resp = Invoke-RestMethod -Method Post -Uri http://127.0.0.1:47190/api/v1/redact -Headers @{ Authorization = "Bearer $key" } -ContentType "application/json" -Body (@{ pdfB64 = $pdf; pages = $pages; style = "black" } | ConvertTo-Json -Depth 6)
if ($resp.report.outputUsable) {
[IO.File]::WriteAllBytes("C:\Akten\gutachten_geschwaerzt.pdf",
[Convert]::FromBase64String($resp.pdfB64))
} else {
# Fail-closed: Ausgabe wurde verworfen — Funde prüfen (remainingPii)
$resp.report.remainingPii
} | pages[].pageNumber / rects[].x,y,width,height | Cajas de detección, páginas desde 1 |
| style | black (por defecto), white, blur o pixelate |
| anonymize | Marcadores tipo [NAME_1] en lugar de barras |
| resiscan | PDF solo imagen (capa de texto destruida) |
| report.outputUsable / remainingPii | Verificación superada / número de restos |
401 unauthorized · 400 bad body/base64 · 404 not found · 500 {error}
Tres recetas
A · Enviar los exports de RA-MICRO / expediente electrónico a una carpeta vigilada
- En RA-MICRO, dirigir el export (PDF) a una carpeta de red, p. ej. \\servidor-despacho\datenmaske\eingang.
- En Datenmaske: Ajustes → Carpetas → añadir esa carpeta como vigilada.
- Modo «Revisión» (por defecto): cada archivo nuevo llega a la biblioteca para revisar; el original pasa al subdirectorio verarbeitet.
- Modo «Auto» solo para datos estructurados: exporta automáticamente fail-closed a redigiert/<nombre>_redigiert.pdf. Nombres y texto libre SIEMPRE van a revisión humana.
- Deduplicación SHA-256: el mismo archivo (aunque renombrado) no se procesa dos veces por usuario.
B · Lote nocturno con script
- En el puesto donde corre Datenmaske, crear una tarea programada (PowerShell).
- El script siguiente lee una carpeta, detecta, tacha y comprueba outputUsable — lo descartado queda visible en la carpeta rechazados.
- Nota: el script corre en la sesión del usuario conectado; la API solo escucha su 127.0.0.1.
C · Desplegar tres puestos con MSI y GPO
- Poner el MSI en un recurso compartido; asignar por GPO (Configuración del equipo → Instalación de software) o Intune — silencioso: msiexec /i Datenmaske-Secure-setup.msi /qn.
- Para redes aisladas, usar el instalador completo (Datenmaske-Secure-full.msi): incluye los modelos de IA; el primer arranque no descarga nada.
- Colocar las plantillas ADMX; las directivas bajo HKLM\SOFTWARE\Policies\Mokka\Datenmaske se leen en cada arranque: AutoUpdateMode (disable/notify/auto), BlockModelDownload (1 = bloquear modelos), HotFolderPath (carpeta vigilada central).
- Introducir la clave de licencia en cada puesto; el menú contextual se activa una vez por usuario en Ajustes → Sistema.
B · Lote nocturno con script
PowerShell · batch.ps1
$key = "MEIN-SCHLUESSEL"
$eingang = "C:\Akten\eingang"
$ok = "C:\Akten\geschwaerzt"
$nein = "C:\Akten\abgelehnt"
$archiv = Join-Path $eingang "verarbeitet"
New-Item -ItemType Directory -Force $ok, $nein, $archiv | Out-Null
Get-ChildItem $eingang -Filter *.pdf | ForEach-Object {
$pdf = [Convert]::ToBase64String([IO.File]::ReadAllBytes($_.FullName))
$det = Invoke-RestMethod -Method Post -Uri http://127.0.0.1:47190/api/v1/detect -Headers @{ Authorization = "Bearer $key" } -ContentType "application/json" -Body (@{ pdfB64 = $pdf } | ConvertTo-Json)
$pages = @($det.suggestions | Group-Object pageNumber | ForEach-Object {
@{ pageNumber = [int]$_.Name; rects = @($_.Group | ForEach-Object {
@{ x = $_.bboxX; y = $_.bboxY; width = $_.bboxWidth; height = $_.bboxHeight } }) } })
$resp = Invoke-RestMethod -Method Post -Uri http://127.0.0.1:47190/api/v1/redact -Headers @{ Authorization = "Bearer $key" } -ContentType "application/json" -Body (@{ pdfB64 = $pdf; pages = $pages } | ConvertTo-Json -Depth 6)
if ($resp.report.outputUsable) {
[IO.File]::WriteAllBytes((Join-Path $ok $_.Name),
[Convert]::FromBase64String($resp.pdfB64))
Move-Item $_.FullName (Join-Path $archiv $_.Name) -Force
} else {
Move-Item $_.FullName $nein -Force # fail-closed: bleibt sichtbar
}
} ! Sin revisión humana: el script solo tacha lo que la detección encuentra. outputUsable confirma la eliminación, no la exhaustividad. En expedientes con nombres, texto libre o escaneos: revisar por muestreo o usar la carpeta vigilada en modo «Revisión».
Lo que las interfaces no hacen
- Sin acceso a red: la API solo escucha 127.0.0.1; conducirla desde otros equipos es deliberadamente imposible.
- La API solo corre con la aplicación abierta; no hay (todavía) modo servicio.
- Sin «dejar a propósito» vía API: un valor rechazado en la interfaz bloquea el export por API (fail-closed estricto).
- El modo «Auto» solo exporta datos estructurados verificados (correo, IBAN, tarjeta, identificador fiscal, seguridad social, pasaporte y seguro). Nombres, direcciones y escaneos pasan siempre por revisión humana.
- Existe un CLI en el proyecto, pero no forma parte del instalador; la vía soportada es la API REST.
- Una petición = un PDF (Base64); procesar en secuencia, el servidor atiende en orden.
- Carpetas de red (UNC) soportadas; ante enlaces inestables, recomendamos una carpeta local de sincronización.
- outputUsable demuestra que los hallazgos seleccionados se eliminaron y que el control de restos está limpio — no que la detección lo encontrara todo. Sin revisión por muestreo queda un riesgo residual.
Diferencia con la API web
Esta página describe la API local del escritorio. La edición web/nube (redact_pdf, detect_pii, get_report con clave) está en la página de documentación de la API — mismas ideas, otra infraestructura. → /es/api-dokumentation
Más información