Introducción
El conector de DocuSign está disponible en Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta en los servicios de DocuSign para utilizar el API de los servicios de Firma Digital.
Para más información de las capacidades de este conector, visite la plataforma Xchange de Bizagi.
|
Este conector utiliza Autenticación code grant OAuth 2.0 y sólo está disponible desde la versión Fall 2022 de Bizagi Studio Cloud.
Este conector fue desarrollado utilizando la información de la API proporcionada por Docusign. Bizagi y sus subsidiarias no garantizan el contenido ni se responsabilizan de los errores que resulten del uso de los servicios de la API de Docusign. Bizagi y sus subsidiarias no son responsables de ninguna pérdida, costo o daño causado por el uso de la API de Docusign. |
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.
Registrar cuenta en DocuSign como Desarrollador
El registrar una cuenta de desarrollador en el DocuSign Developer Center le permite obtener un clientId y un secretId que son necesarios para acceder a su API.
Para crear su cuenta siga estos pasos:
1.Acceda al DocuSign Developer Center y seleccione la opción de Crear cuenta en el menú de Cuenta de Desarrollador.
2.Una vez creada la cuenta, active su cuenta con el correo de confirmación que le llega a la cuenta que registró.
3.Una vez se active la cuenta, vuelva a iniciar sesión en el DocuSign Developer Center y seleccione en el menú de la cuenta la opción de Mis Llaves y Aplicaciones.
4.En la vista de Llaves y Aplicaciones, usted va a encontrar la información relacionada a su cuenta y además, la opción de crear Aplicaciones API con el botón de Agregar Aplicaciones y llaves de integración.
5.En la ventana de Agregar Llave de Integración asigne un nombre para si Aplicación API y de clic en el botón Crear Aplicación para guardar sus cambios.
6.Una vez creada la Aplicación de API, usted puede revisar la Llave de Integración generada en la sección de Información General.
7.Para generar una Secretkey (SecretId), navegue a la sección de Autenticación y haga clic en el botón Agregar Secret keys. Automaticamente se le generará una llave. Es necesario que usted pueda guardar esta llave ya que solo se puede visualizar una vez y es necesario para la integración del conector en Bizagi como parte del proceso de autenticación.
8.En la sección de Configuraciones Adicionales, usted debe agregar el siguiente enlace de Redirect URIs: https://build.bizagi.com/redirectOauth2.html. Para guardar todos los cambios haga clic en el botón Guardar.
Configurar el conector
Para configurar el conector en Bizagi Studio, siga los pasos presentados en el capítulo de Configuración de conectores.
Para esta configuración, considere los siguientes parámetros de autenticación:
•Authentication method: OAuth2 Authentication.
•OAuth2 flow: Authorization Code Grant.
•response_type: code
•redirect_uri: Bizagi sets it by default
•client_id: la integration key de su aplicación
•client_secret: la secret key de su aplicación
•auth_url: https://account-d.docusign.com/oauth/auth
•token_url: https://account-d.docusign.com/oauth/token
•scope: Signature
Cuando haya ingresado los parámetros de autenticación, haga clic en Autorizar, para que aparezca una ventana emergente donde debe ingresar los datos de su cuenta.
Después, aparece una ventana donde le solicita la contraseña.
Luego, para acceder se selecciona Allow Access.
Al finalizar aparece mensaje de éxito de la autenticación y haga clic en Listo para terminar la configuración.
Usar el conector
Éste conector permite el uso de siete métodos de los servicios de DocuSign: Solicitar vista del recipiente, Enviar Plantilla, Crear Sobre, Crear Vista de remitente, Obtener Sobre, Obtener documento del sobre y Obtener Lista de Documentos del sobre.
Para aprender en general cómo y dónde configurar el uso de un conector, por favor visite el artículo Utilizar conectores.
Al usar el conector, asegúrese de considerar los siguientes detalles de cada uno de los métodos disponibles:
Solicitar vista del recipiente (requestRecipientView)
Este método genera la URL para que el recipiente realice la firma.
Para configurar sus inputs, mapee de la siguiente manera:
•envelopeId: Identificador único del sobre.
•recipientName: Nombre completo del recipiente.
•recipientEmail: correo electrónico del recipiente.
•clientUserId: Un valor definido por el remitente, el cual identifica el recipiente embebido y permite que se genere la URL. 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 outputs e iniciar pruebas, puede mapear el atributo url:
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Enviar Plantilla (sendTemplate)
Este método crea y envía un sobre con un recipiente embebido
Para configurar sus inputs, mapee de la siguiente manera:
•fileName: El nombre del nuevo documento.
•fileContents: Contenidos del nuevo documento.
•fileExtension: La extensión del nuevo documento.
•documentId: Este valor depende completamente del cliente. La ID del documento en el cual se coloca la etiqueta.
•recipientName: Nombre complete del recipiente.
•recipientEmail: El correo eléctronico del recipiente.
•recipientId: Campo único para el recipiente. Es usado para indicar cual recipiente 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, el cual identifica el recipiente embebido y permite que la url para realizar la firma sea generada. Este parámetro espera un valor numérico.
•xPosition: Indica el offset horizontal de la etiqueta en la página (DocuSign usa 72 DPI para determinar la posición).
•yPosition: Indica el offset vertical de la etiqueta en la página (DocuSign usa 72 DPI para determinar la posición).
•emailSubject: Asunto que Docusign envía en el correo electrónico al destinatario.
•pageNumber: Especifica el numero de la página donde se ubica la etiqueta.
Para configurar sus outputs e iniciar pruebas, puede mapear como en la siguiente imagen:
•envelopeId: Identificador único del sobre recientemente creado.
•status: Estado del sobre recientemente creado.
•statusDateTime: fecha y hora cuando el sobre fue creado.
•uri: URL generada para acceder al sobre recientemente creado.
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Crear Sobre (Envelope Create)
Este método crea y envía un sobre nuevo.
Para configurar sus inputs, mapee de la siguiente manera:
•documents: Lista de los documentos del sobre que van a ser firmados.
De esta forma y mapeando también los elementos internos documentBase64, documentId, fileExtension y name, usted puede enviar la lista de documentos a ser firmados.
Para el elemento fileName, usted puede especificar el nombre a través de texto o mapear la propiedad fileName desde un atributo de archivos de Bizagi y para el elemento documentBase64, mapee la propiedad data desde el mismo atributo de archivos de tal forma que se envíe un arreglo de bytes (byte[]) con el contenido del archivo.
•emailSubject: Asunto del correo electrónico utilizado para enviar el sobre a los recipientes.
•signers: Lista de usuarios que van a recibir el sobre y firmarán los documentos.
De esta forma y mapeando también los elementos internos email, name, recipientId y note, usted puede enviar la lista de firmantes de los documentos.
•accountid: Identificador único de su cuenta de DocuSign.
•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 Solicitar vista de destinatario.
•status: Estado del sobre. Ingrese sent si el sobre será enviado inmediatamente a los recipientes o created si el sobre será guardado y enviado después.
•cc: Lista de usuarios que van a recibir una copia del sobre.
De esta forma y mapeando también los elementos internos email, name, recipientId, y note, usted puede enviar la lista de usuarios que van a recibir la copia.
Para configurar sus outputs e iniciar pruebas, puede mapear como en la siguiente imagen:
•envelopeId: Identificador único del sobre recientemente creado.
•status: Estado del sobre recientemente creado.
•statusDateTime: fecha y hora cuando el sobre fue creado.
•uri: URL generada para acceder al sobre recientemente creado.
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Crear Vista de remitente (EvelopeView CreateSender)
Este método crea una nueva vista de Remitente
Para configurar sus inputs, mapee de la siguiente manera:
•accountid: Identificador único de la cuenta de DocuSign del creador del sobre.
•envelopeId: Identificador único del sobre recientemente creado.
•returnUrl: URL generado en acciones previas para acceder al sobre.
Para configurar sus outputs e iniciar pruebas, puede mapear la url retornada.
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Obtener Sobre (Envelope Get)
Este método obtiene un sobre a partir de su identificador.
Para configurar sus inputs, mapee de la siguiente manera:
•accountid: Identificador único de la cuenta de DocuSign del creador del sobre.
•envelopeId: Identificador único del sobre.
Para configurar sus outputs e iniciar pruebas, puede mapear como en la siguiente imagen:
•allowMarkup: especifica si está habilitado el marcado (markup) (true) o no (false).
•autoNavigation: especifica si el usuario puede redirigir el sobre a otro recipiente (true) o no (false).
•brandId: Identificador único del brand del sobre
•certificateUri: URI del endpoint utilizado para traer la información del certificado del sobre.
•createdDateTime: Fecha de creación del sobre.
•customFieldsUri: URI del endpoint utilizado para traer los archivos personalizados del sobre.
•documentsCombinedUri: URI del endpoint utilizado para traer los documentos combinados del sobre.
•documentsUri: URI del endpoint utilizado para traer los documentos del sobre.
•emailSubject: Asunto del correo electrónico utilizado para enviar el sobre a los recipientes.
•enableWetSign: especifica si el firmate puede imprimir y firmar el documento (true) o no (false).
•envelopeId: Identificador único del sobre.
•envelopeIdStamping: Especifica si se utiliza Envelope ID Stamping (true) o no (false).
•envelopeUri: URI del endpoint utilizado para traer los sobres.
•initialSentDateTime: Fecha de envío del sobre.
•is21CFRPart11: especifica si este módulo está habilitado en la cuenta (true) o no (false).
•isSignatureProviderEnvelope: especifica si el sobre es Signature Provider (true) o no (false).
•lastModifiedDateTime: Fecha de la última actualización del sobre.
•notificationUri: URI del endpoint utilizado para traer las notificaciones del sobre.
•purgeState: Current purge state for the envelope.
•recipientsUri: URI del endpoint utilizado para traer los recipientes.
•sentDateTime: Fecha de envío del sobre.
•statusChangedDateTime: Fecha de la última actualización de estado del sobre.
•status: Estado del sobre.
•templatesUri: URI del endpoint utilizado para traer las plantillas
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Obtener documento del sobre (EnvelopeDocument Get)
Este método obtiene un documento a partir de su identificador, su sobre y el identificador de la cuenta.
Para configurar sus inputs, mapee de la siguiente manera:
•accountid: Identificador único de la cuenta de DocuSign del creador del sobre.
•envelopeId: Identificador único del sobre.
•documentid: Identificador único del documento.
Para configurar sus outputs e iniciar pruebas, puede mapear como en la siguiente imagen:
•data: Mapee el atributo en la propiedad data de un atributo de tipo archivo de Bizagi para que el arreglo de bytes (byte[]) tenga el contenido del documento.
•FileName: Mapee el atributo en la propiedad fileName de un atributo de tipo archivo de Bizagi.
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Obtener Lista de Documentos del sobre (EnvelopeDocument list)
Este método obtiene la lista de documentos con su autenticación.
Para configurar sus inputs, mapee de la siguiente manera:
•accountid: Identificador único de la cuenta de DocuSign del creador del sobre.
•envelopeId: Identificador único del sobre.
Para configurar sus outputs e iniciar pruebas, puede mapear como en la siguiente imagen:
•envelopeDocuments: Mapeelo a una colección en su modelo de datos.
odisplay: refiere a las propiedades de mostrado y comportamiento del documento.
odocumentId: Identificador único del documento.
oincludeInDownload: especifica si este módulo está incluido en la descarga combinada del documento (true) o no (false).
oname: Nombre del documento.
oorder: define si el documento es ordenado de forma ascendente o descendente.
opages: número de páginas del documento.
osignerMustAcknowledge: muestra cómo interactua el firmante con el documento.
otype: tipo de usuario (type_owner o type_participant).
ouri: URL creada para acceder al documento.
Para más información acerca del uso de este método, consulte la documentación oficial de los servicios de DocuSign.
Last Updated 10/7/2024 11:36:16 AM