Introducción
El conector DocuSign de Bizagi está disponible para descargar en el Connectors Xchange de Bizagi .
A través de este conector, usted podrá conectar sus procesos Bizagi a una cuenta DocuSign para utilizar la API de servicios de Firma Electrónica.
Para mayor información sobre las capacidades de este conector, visite Bizagi Connectors Xchange.
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.El conector instalado, ya sea a través del Connectors Xchange o mediante instalación manual según se describe en el artículo Instalar y administrar conectores.
3.Una cuenta registrada de DocuSign sandbox developer.
Configurar el conector
Para configurar el conector (es decir, sus parámetros de autenticación), siga los pasos presentados en el capítulo Configuración del artículo Instalar y administrar conectores.
Para esta configuración, considere los siguientes parámetros de autenticación:
•subdomain: Subdominio asignado por DocuSign a su cuenta adquirida. Para las cuentas de prueba, utilice demo.
•Authentication method: personalizado
•email: el correo electrónico asociado a su cuenta de DocuSign.
•password: la contraseña asociada a su cuenta de DocuSign.
•integratorKey: Una clave de integración de DocuSign válida (generada previamente en el paso anterior).
Usar el conector
Este conector cuenta con siete métodos disponibles de servicios DocuSign: Solicitar vista de destinatario, Enviar plantilla, Crear sobre, Crear vista de remitente, Obtener sobre, Obtener documento de sobre y Obtener lista de documentos de sobre.
Para obtener información general sobre cómo/dónde configurar el uso de un conector, consulte la documentación de Utilizando Conectores.
Cuando utilice el conector, asegúrese de tener en cuenta los siguientes detalles para cada uno de los dos métodos disponibles.
Solicitar vista de destinatario
Para configurar sus entradas, considere lo siguiente:
•envelopeId: identificador único del sobre.
•recipientName: nombre completo del destinatario.
•recipientEmail: el correo electrónico del destinatario.
•clientUserId: un valor definido por el remitente que identifica al destinatario incrustado y permite generar una URL de firma para él. Este parámetro espera un valor numérico.
•returnUrl: URL a la que se redirige al destinatario una vez finalizada la sesión.
•recipientClientUserId: este parámetro es opcional. Es el mismo ID que se envía al crear el sobre. Si no se envía este parámetro, se generará una vista de remitente en lugar de una vista de firmante.
Para configurar sus salidas al iniciar y probar, puede mapear la URL de respuesta de la salida:
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Enviar plantilla
Este método crea y envía un sobre con un destinatario integrado.
Para configurar sus entradas, considere lo siguiente:
•fileName: el nombre del nuevo documento.
•fileContents: los contenidos del nuevo documento.
•fileExtension: la extensión del nuevo documento.
•documentId: este valor depende completamente del cliente. El número de identificación del documento en el que se coloca la ficha.
•recipientName: el nombre completo del destinatario.
•recipientEmail: el correo electrónico del destinatario.
•recipientId: único para el destinatario. Se utiliza para indicar qué destinatario debe firmar el documento. Este parámetro espera un valor numérico.
•recipentClientUserId: este parámetro es opcional. Si se especifica, identifica al firmante con un ID único. Este parámetro se utiliza en la acción Solicitar vista de destinatario.
•clientUserId: un valor definido por el remitente que identifica al destinatario incrustado y permite generar una URL de firma para él. Este parámetro espera un valor numérico.
•xPosition: indica el desplazamiento horizontal de la ficha en la página (DocuSign utiliza 72 PPP al determinar la posición).
•yPosición: indica el desplazamiento vertical de la pestaña en la página (DocuSign utiliza 72 PPP para determinar la posición).
•emailSubject: asunto que DocuSign envía en el correo electrónico al destinatario.
•pageNumber: indica el número de página en el que se encuentra la pestaña.
Para configurar sus salidas cuando se inicia y realiza pruebas, puede asignar:
•envelopeId: identificador único del sobre creado recientemente.
•status: estado del sobre creado recientemente.
•statusDateTime: fecha y hora de creación del sobre.
•URI: URL generada para acceder al sobre recién creado.
Para más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Crear sobre
Este método crea y envía un nuevo sobre
Para configurar sus entradas, considere lo siguiente:
•documents: lista de los documentos a firmar en el sobre.
De esta forma mapeando también sus elementos internos documentBase64, documentId, fileExtension, y name, se puede enviar la lista de los documentos a firmar.
Para el elemento fileName, usted puede especificar a través de texto, un nombre para el archivo o mapear la propiedad fileName desde un atributo de archivo Bizagi, y para documentBase64, mapear la propiedad data desde el mismo atributo de archivo Bizagi para que un arreglo de bytes (byte[]) sea enviado con el contenido real del archivo.
•emailSubject: asunto del correo electrónico utilizado para enviar el sobre a los destinatarios.
•clientUserId: este parámetro es opcional. Si se especifica, identifica al firmante con un ID único. Este parámetro se utiliza en la acción Request Recipient View.
•signers: lista de los usuarios que van a recibir el sobre y firmar los documentos.
De esta forma y mapeando también sus elementos internos email, name, recipientId, y note, se puede enviar la lista de los firmantes de los documentos.
•accountid: identificador único de tu cuenta DocuSign.
•status: el estado del sobre. Establezca sent si el sobre se enviará inmediatamente a los destinatarios o created si el sobre se guardará y se enviará más tarde.
•cc: lista de los usuarios que van a recibir una copia del sobre. De esta forma mapeando también sus elementos internos email, name, recipientId, y note, puedes enviar la lista de los destinatarios copiados.
Para configurar sus salidas cuando se inicia y pruebas, puede asignar:
•envelopeId: identificador único del sobre creado recientemente.
•status: estado del sobre creado recientemente.
•statusDateTime: fecha y hora de creación del sobre.
•URI: URL generada para acceder al sobre recién creado.
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Crear vista de remitente
Para configurar sus entradas, considere lo siguiente:
•accountid: identificador único de la cuenta DocuSign del usuario creador del sobre.
•envelopeId: identificador único del sobre.
•returnUrl: URL generada en acciones anteriores para acceder al sobre.
Para configurar sus salidas al iniciar y realizar pruebas, puede asignar la url de respuesta de la salida.
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Obtener sobre
Este método obtiene un sobre a partir de su ID.
Para configurar sus entradas, considere lo siguiente:
•accountid: identificador único de la cuenta DocuSign del usuario creador del sobre.
•envelopeId: identificador único del sobre.
Para configurar sus salidas al iniciar y realizar pruebas, puede mapear:
•allowMarkup: especifica si el marcado está habilitado (true) o no (false).
•autoNavigation: especifica si el usuario puede redirigir un sobre a otro destinatario (true) o no (false).
•brandId: identificador único de la marca del sobre.
•certificateUri: URI del punto de conexión utilizado para recuperar la información del certificado del sobre.
•createdDateTime: fecha en la que se creó el sobre.
•customFieldsUri: URI del punto de conexión utilizado para recuperar los campos personalizados del sobre.
•documentsCombinedUri: URI del punto de conexión utilizado para recuperar los documentos combinados del sobre.
•documentsUri: URI del punto de conexión utilizado para recuperar los documentos del sobre.
•emailSubject: asunto del correo electrónico utilizado para enviar el sobre a los destinatarios.
•enableWetSign: especifica si el firmante puede imprimir y firmar el documento (true) o no (false).
•envelopeId: identificador único del sobre.
•envelopeIdStamping: especifica si el estampado del ID del sobre está habilitado (true) o no (false).
•envelopeUri: URI del punto de conexión utilizado para recuperar los sobres.
•initialSentDateTime: fecha en la que se envió el sobre.
•is21CFRPart11: especifica si este módulo está habilitado en la cuenta (true) o no (false).
•isSignatureProviderEnvelope: especifica si el sobre es Proveedor de firmas (true) o no (false).
•lastModifiedDateTime: fecha de la última actualización del sobre.
•notificationUri: URI del punto de conexión utilizado para recuperar las notificaciones del sobre.
•purgeState: estado actual de purga del sobre.
•recipientsUri: URI del punto de conexión utilizado para recuperar los destinatarios.
•sentDateTime: fecha en la que se envió el sobre.
•statusChangedDateTime: fecha de la última actualización de estado del sobre.
•status: estado del sobre.
•templatesUri: URI del punto de conexión utilizado para recuperar las plantillas.
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Obtener documento de sobre
Este método obtiene un documento a partir de su ID, su ID de sobre y su ID de cuenta.
Para configurar sus entradas, considere lo siguiente:
•accountid: identificador único de la cuenta DocuSign del usuario creador del sobre.
•envelopeId: identificador único del sobre.
•documentid: identificador único del documento.
Para configurar sus salidas cuando se inicia y se realizan pruebas, puede mapear:
•data: Mapear el atributo a la propiedad data de un atributo de archivo Bizagi para que el array de bytes (byte[]) tenga el contenido del documento.
•FileName: Mapea el atributo a la propiedad fileName de un atributo de archivo Bizagi.
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Obtener lista de documentos de sobre
Para configurar sus entradas, considere lo siguiente:
•accountid: identificador único de la cuenta DocuSign del usuario creador del sobre.
•envelopeId: identificador único del sobre.
Para configurar sus salidas al empezar y hacer pruebas, puede asignar:
•envelopeDocuments: mapea esto a una colección en tu modelo de datos.
odisplay: las propiedades de visualización y comportamiento del documento.
odocumentId: identificador único del documento.
oincludeInDownload: especifica si este módulo se incluye en la descarga combinada de documentos (true) o no (false).
oname: nombre del documento.
oorder: define si el documento se ordena de forma ascendente o descendente.
opages: número de páginas del documento.
osignerMustAcknowledge: muestra cómo interactúa el firmante con el documento.
otype: tipo del usuario (type_owner o type_participant).
oURI: URL creada para acceder al documento.
Para obtener más información sobre el uso de este método, consulte la documentación oficial de DocuSign.
Last Updated 10/7/2024 4:05:08 PM