SDKs de embed
Instala el SDK de embed de React, Vue, Svelte, Angular, Solid o Preact e integra la firma de Digito.
Los SDKs de embed presentan la firma de un destinatario dentro de tu aplicación. El componente recibe el token de ese destinatario y utiliza host="https://business.digito.do" para abrir el flujo de Digito.
Publicación de los paquetes
La publicación de los paquetes @digitogroup/embed-* está prevista. Esta documentación describe los forks que Digito publicará; los comandos de instalación requieren que el paquete correspondiente ya esté disponible.
Elige tu framework
| Framework | Paquete | Guía |
|---|---|---|
| React | @digitogroup/embed-react | Embed en React. |
| Vue | @digitogroup/embed-vue | Embed en Vue. |
| Svelte | @digitogroup/embed-svelte | Embed en Svelte. |
| Angular | @digitogroup/embed-angular | Embed en Angular. |
| Solid | @digitogroup/embed-solid | Embed en Solid. |
| Preact | @digitogroup/embed-preact | Embed en Preact. |
Cada guía incluye instalación, importación del componente, token del destinatario y callback de finalización. React incluye un ejemplo completo con estados de carga, documento listo, finalización y error.
Componentes de embed
| Componente | Función | Acceso |
|---|---|---|
EmbedSignDocument | Presentar la firma de un destinatario de un documento concreto. | Token del destinatario. |
EmbedCreateEnvelope | Crear un sobre de documento o plantilla en el editor. | Token presign emitido por el servidor. |
EmbedUpdateEnvelope | Editar un sobre existente. | Token presign y envelopeId del sobre. |
Para obtener el token de destinatario y organizar el proceso, consulta embed de firma. La creación y edición se explican con sus propiedades y eventos en embed del editor.
Propiedades de firma
| Propiedad | Tipo | Uso |
|---|---|---|
token | string | Token del destinatario autorizado; obligatorio. |
host | string | Usa https://business.digito.do en todos los componentes. |
name | string | Nombre que se presenta en el flujo. |
lockName | boolean | Controla si se permite cambiar ese nombre. |
language | string | Idioma del embed; utiliza es para español. |
onDocumentReady | función | Informa que el documento está listo. |
onDocumentCompleted | función | Informa que la persona completó su acción. |
onDocumentError | función | Informa un error del flujo. |
Los ejemplos de personalización utilizan css, cssVars y darkModeDisabled. Consulta apariencia del embed para conocer su aplicación y las opciones admitidas para la integración.
Callbacks y estado del servidor
onDocumentCompleted recibe los identificadores del evento: documentId, recipientId y el token utilizado. Los sobres v2 también incluyen envelopeId, un string. Conserva las credenciales y evita registrar el payload completo. Los callbacks actualizan la interfaz; tu servidor consulta el sobre y sus destinatarios para confirmar el resultado.
Los eventos del editor son onEnvelopeCreated y onEnvelopeUpdated. El ID del sobre v2 se conserva como string; no lo conviertas al documentId numérico de un evento de firma. Las propiedades y los payloads del editor están en su guía.
Autenticación y recuperación
El firmante se autentica de nuevo con Digito ID antes de cada acción de firma. Una sesión abierta en Business, una clave de API, un token de destinatario o un token presign no sustituye esta autenticación.
Obtén el token del destinatario desde tu servidor después de comprobar su acceso al sobre. Conserva la clave de API en el servidor. El componente recibe solo el token del destinatario autorizado.
Un callback del embed permite actualizar la interfaz; tu servidor debe consultar el sobre y su destinatario para confirmar el resultado. Los eventos pueden repetirse; evita actualizar el proceso dos veces.
Gestiona carga, error, acceso vencido y finalización. Si cambia el destinatario, desmonta el componente anterior para no conservar su acceso. Obtén un acceso nuevo desde el servidor cuando corresponda; recargar el componente no debe crear ni distribuir otro documento.
En una aplicación con SSR, inicializa el embed en el cliente y conserva las operaciones autenticadas en el servidor. El navegador recibe el acceso específico del destinatario o el token presign, según el componente utilizado.