PDF Redaction
Widget para sitios web

Widget integrable

Integra la redacción de PDF directamente en tu propio sitio web mediante una etiqueta script o un componente de React.

El widget de PDF Redaction te permite integrar el flujo subir → detectar PII → redactar → descargar directamente en tu propio sitio web, sin enviar archivos a través de tu propio backend. Se ejecuta dentro de un iframe aislado (sandboxed) alojado en pdf-redaction.com y se autoriza por dominio con una de tus claves de API. Usa el mismo motor de OCR en el navegador que la aplicación principal y es compatible con más de 100 idiomas.

El widget integrado en modo editor completo, con el panel de revisión de PII y entidades detectadas como teléfono, correo electrónico, ubicación, dirección, código postal, URL, organización y rostro


1. Crea una clave de API con el widget habilitado

  1. Ve a https://pdf-redaction.com/apikeys/ y crea una clave de API (o reutiliza una existente).
  2. Haz clic en el icono del widget junto a la clave para abrir la configuración Embeddable Widget Settings.
  3. Añade los dominios que pueden integrar el widget con esta clave (por ejemplo, example.com). Si lo dejas vacío, cualquier dominio podrá usar la clave, algo no recomendable en producción.
  4. Elige un modo predeterminado:
    • Full editor (editor completo): la misma experiencia de subir, revisar, redactar y descargar que en pdf-redaction.com.
    • Auto redact (redacción automática): un flujo de un solo clic; sueltas un archivo, se analiza y se redacta automáticamente, y comienza la descarga.
  5. Copia el fragmento de código generado para tu integración (ver más abajo).

2. Integración mediante etiqueta script

Añade esto a cualquier página de un dominio permitido:

<script src="https://pdf-redaction.com/widget.js"></script>
<div id="pdf-redaction-widget"></div>
<script>
  PdfRedactionWidget.init({
    key: 'YOUR_API_KEY',
    container: '#pdf-redaction-widget',
    mode: 'auto', // or 'full'; omit to use the key's default mode
    locale: 'es',
    onRedactionComplete: function (fileName) {
      console.log('Redaction complete:', fileName)
    },
    onError: function (message) {
      console.error('Widget error:', message)
    },
  })
</script>

El widget se muestra como un iframe adaptable que ajusta automáticamente su altura al contenido.


3. Integración con React (en desarrollo)

Para aplicaciones React, instala @stabrise/redaction-widget-react y usa el componente RedactionWidget, un envoltorio ligero sobre el mismo iframe que utiliza el cargador de script:

import { RedactionWidget } from '@stabrise/redaction-widget-react'

function MyPage() {
  return (
    <RedactionWidget
      apiKey="YOUR_API_KEY"
      mode="auto"
      onRedactionComplete={(fileName) => console.log('done', fileName)}
      onError={(message) => console.error(message)}
    />
  )
}

Cómo funciona la autorización

El widget reutiliza tu clave de API existente en lugar de una credencial aparte. Como la clave se usa en el lado del cliente (es visible en el código fuente de tu página), la autorización se basa en el dominio y no en el secreto, de forma similar a una clave de Google Maps™ o a una clave publicable de Stripe:

  • Cuando se carga el iframe del widget, envía tu clave y el origen de la página que lo integra a pdf-redaction.com para validarlos.
  • Si has configurado dominios permitidos para la clave, el widget solo se muestra cuando el origen de la página coincide con uno de ellos.
  • Si no configuras dominios permitidos, la clave se puede usar desde cualquier sitio; hazlo solo para pruebas.

Modos

ModoComportamiento
fullMuestra el editor de redacción completo: subida, detección automática de PII, revisión manual de los elementos detectados y descarga.
autoSube el archivo, detecta PII automáticamente, redacta todo lo detectado e inicia la descarga sin paso de revisión manual.

Eventos postMessage

Tanto el cargador de script como el componente de React se comunican con la página integrada mediante postMessage. Si creas una integración propia directamente con el iframe, los valores de type de los mensajes son:

  • pdf-redaction:widget:ready: iframe → página contenedora, se envía al montarse.
  • pdf-redaction:widget:init: página contenedora → iframe, se envía como respuesta a ready.
  • pdf-redaction:widget:resize: iframe → página contenedora, { height } en píxeles.
  • pdf-redaction:widget:redaction-complete: iframe → página contenedora, { fileName }.
  • pdf-redaction:widget:error: iframe → página contenedora, { message }.