Microaplicaciones

Integrar DocuSign

Implemente la integración de DocuSign para enviar y recibir sobres para firmas digitales desde cualquier dispositivo a través de Citrix Workspace. Los usuarios pueden iniciar una nueva plantilla para firma, recibir notificaciones de cualquier nuevo documento pendiente y ver una lista de sobres enviados o recibidos previamente en su bandeja de entrada de DocuSign.

Nota:

¡Su opinión nos interesa! Proporcione comentarios sobre esta plantilla de integración a medida que la utiliza. Para cualquier problema, nuestro equipo también supervisará el foro dedicado a diario.

Para obtener información detallada sobre las microaplicaciones de uso inmediato para DocuSign, consulte Usar microaplicaciones de DocuSign.

Revisar requisitos previos

En estos requisitos previos, se entiende que el administrador forma parte de la estructura de integración de DocuSign de la organización. Esta cuenta de administrador de DocuSign debe tener privilegios de lectura sin restricciones de la información del usuario.

Tras configurar esta integración con DocuSign, necesitará estos artefactos para agregar la integración en las microaplicaciones de Citrix Workspace; en concreto, la siguiente lista de parámetros para configurar la integración de OAuth:

  • URL base: URL base a la que se anexan las rutas de dispositivo de punto final. Puede obtener la URL base de la cuenta de servicio, en Apps and Keys. Formato de URL base: {baseURL fetched from sevice account}/restapi/2.1/. Para obtener información sobre cómo encontrar la URL base, consulte Configurar el servidor de OAuth.
  • ID de cuenta de DocuSign: Su ID de cuenta de administrador de DocuSign. Consulte Configurar el servidor de OAuth.
  • URL de entorno: por ejemplo, a partir de la URL base https://{yourEnvironmentalURL}.docusign.net/restapi/v2.1/.
  • URL de autorización: https://account-d.docusign.com/oauth/auth
  • URL del token: https://account-d.docusign.com/oauth/token
  • ID de cliente: El ID de cliente es la cadena que representa la información de registro del cliente exclusiva del servidor de autorización. Además, todas las claves de aplicación de DocuSign deben superar el proceso de lanzamiento (paso del modo de demostración al de producción) de DocuSign. Esto se aplica a la clave de integración (ClientId). Esto puede tardar hasta una semana. Para obtener más información sobre el proceso de lanzamiento de DocuSign, consulte https://developers.docusign.com/docs/esign-rest-api/go-live/.
  • Secreto del cliente: El secreto del cliente es la cadena única emitida al configurar la integración de la aplicación de destino.

Nota:

Se recomienda utilizar OAuth 2.0 como método de autenticación del servicio siempre que esté disponible. OAuth 2.0 garantiza que la integración es conforme a los requisitos de seguridad más estrictos con la microaplicación configurada.

Configure Citrix Gateway para que admita Single Sign-On para DocuSign, de modo que, una vez que los usuarios hayan iniciado sesión, no tengan que volver a introducir sus credenciales para registrarse. Para obtener más información acerca de la configuración de SSO, consulte Citrix Gateway Service.

El número de solicitudes de API que se pueden realizar a recursos específicos es limitado, por lo que recomendamos lo siguiente:

Enlace al formulario de limitación de API de DocuSign: https://developers.docusign.com/docs/esign-soap-api/esign101/security/call-limits/

Crear una cuenta de servicio

Regístrese aquí: https://admin.docusign.com. Puede ver los perfiles de permisos de usuario aquí: https://support.docusign.com/en/guides/ndse-admin-guide-permission-sets. Si quiere acceder a la versión de demostración de eSignature Admin, utilice esta URL en su lugar: https://admindemo.docusign.com. Para obtener más información sobre nuevas cuentas de servicio, consulte: https://support.docusign.com/en/guides/org-admin-guide-getting-started.

Configurar el servidor de OAuth

Configure el servidor de OAuth para que lea los datos a través de la integración de DocuSign.

  1. Inicie sesión en eSignature Admin con su cuenta de servicio: https://admin.docusign.com. Para la versión de demostración de eSignature Admin: https://admindemo.docusign.com. Para obtener más información, consulte https://support.docusign.com/en/guides/ndse-admin-guide-access y https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
  2. Vaya a Setting en la barra de navegación.
  3. En la página de configuración, seleccione Apps and Keys y, a continuación, ADD APP & INTEGRATION KEY.
  4. Introduzca un nombre de aplicación en APP name y seleccione ADD.
  5. Seleccione +Add Secret Key para generar una clave secreta.
  6. Introduzca el URI de redirección: https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. Copie y guarde los valores de clave de integración y clave secreta (ClientId y Secret) que aparecen en la pantalla. Utilice estos detalles para la autenticación de servicio mientras configura la integración.
  8. Copie y guarde el URI base de la cuenta.
  9. Copie y guarde el ID de cuenta de DocuSign.

Además, todas las claves de aplicación de DocuSign deben superar el proceso de lanzamiento (paso del modo de demostración al de producción) de DocuSign. Esto se aplica a la clave de integración (ClientId). Esto puede tardar hasta una semana. Para obtener más información sobre el proceso de lanzamiento de DocuSign, consulte https://developers.docusign.com/docs/esign-rest-api/go-live/.

Configurar cliente de OAuth

Configure el cliente de OAuth para reescritura de datos a través de la integración de DocuSign.

  1. Inicie sesión en eSignature Admin con su cuenta de servicio: https://admin.docusign.com. Para la versión de demostración de eSignature Admin: https://admindemo.docusign.com. Para obtener más información, consulte https://support.docusign.com/en/guides/ndse-admin-guide-access y https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
  2. Vaya a Setting en la barra de navegación.
  3. En la página de configuración, seleccione Apps and Keys y, a continuación, ADD APP & INTEGRATION KEY.
  4. Introduzca un nombre de aplicación en APP name y seleccione ADD.
  5. Seleccione +Add Secret Key para generar una clave secreta.
  6. Introduzca el URI de redirección: https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  7. Copie y guarde los valores de clave de integración y clave secreta (ClientId y Secret) que aparecen en la pantalla. Utilice estos detalles para la autenticación de acciones de servicio mientras configura la integración.

Además, todas las claves de aplicación de DocuSign deben superar el proceso de lanzamiento (paso del modo de demostración al de producción) de DocuSign. Esto se aplica a la clave de integración (ClientId). Esto puede tardar hasta una semana. Para obtener más información sobre el proceso de lanzamiento de DocuSign, consulte https://developers.docusign.com/docs/esign-rest-api/go-live/.

Configurar organización

Vincule cuentas a su organización. La cuenta que usó para crear la organización se vincula automáticamente.

  1. En la página de inicio de eSignature Admin, seleccione GET STARTED. Si no ve esta opción en su cuenta de DocuSign, DocuSign Admin no está habilitado en la cuenta. Póngase en contacto con el administrador de su cuenta DocuSign para obtener ayuda.
  2. Complete los campos Organization Name y Description (opcional) y, a continuación, seleccione NEXT.
  3. Seleccione CREATE para terminar de crear la organización. Para obtener más información, consulte https://support.docusign.com/en/guides/org-admin-guide-create-org.
  4. Vaya al panel de mandos Organization Admin. Seleccione Connected Apps y, a continuación, AUTHORIZE APPLICATION.
  5. Seleccione el nombre de la aplicación que introdujo y creó al configurar el servidor y el cliente de OAuth. Seleccione ADD para proporcionar permisos.
  6. Introduzca estos ámbitos. Para obtener más información, consulte: https://developers.docusign.com/platform/auth/reference/scopes.
    • Para la autenticación del servicio, seleccione el nombre de aplicación que creó en Configurar el servidor de OAuth, proporcione el permiso user_read y seleccione ADD.
    • Para la autenticación de acciones de servicio, seleccione el nombre de aplicación que creó en Configurar cliente de OAuth, proporcione el permiso user_write y seleccione ADD.

Agregar la integración a las microaplicaciones de Citrix Workspace

Agregue la integración de DocuSign a las microaplicaciones de Citrix Workspace para conectarse a su aplicación. Las opciones de autenticación están preseleccionadas. Compruebe que estas opciones estén seleccionadas a medida que complete el proceso. Esto proporciona microaplicaciones de uso inmediato con notificaciones y acciones preconfiguradas que se pueden usar desde ya en su espacio de trabajo.

Siga estos pasos:

  1. En la página Integraciones de microaplicaciones, seleccione Agregar nueva integración y Agregar una nueva integración a partir de plantillas proporcionadas por Citrix.
  2. Seleccione el mosaico de DocuSign.
  3. En el campo Nombre de la integración, introduzca un nombre para la misma.
  4. Introduzca los parámetros del conector.
    • Introduzca la URL base de la instancia:
    • Seleccione un icono para la integración en la Biblioteca de iconos, o deje el icono predeterminado.

    Parámetros de DocuSign

  5. Introduzca el ID de cuenta de DocuSign. Consulte Configurar el servidor de OAuth.
  6. En Autenticación de servicio, seleccione OAuth 2.0 en el menú Método de autenticación y complete los detalles correspondientes. Las opciones de autenticación están preseleccionadas. Compruebe que estas opciones estén seleccionadas a medida que complete el proceso. Utilice el protocolo de seguridad de OAuth 2.0 para generar tokens de solicitud/autorización para el acceso delegado. Se recomienda utilizar OAuth 2.0 como método de autenticación del servicio siempre que esté disponible. OAuth 2.0 garantiza que la integración es conforme a los requisitos de seguridad más estrictos con la microaplicación configurada.

    1. Seleccione Código de autorización en el menú Tipo de concesión. De esta manera, se concede un código temporal que el cliente intercambia por un token de acceso. El código se obtiene del servidor de autorización, donde se puede ver la información que solicita el cliente. Solo este tipo de concesión permite la suplantación segura de usuarios. Se muestra la URL de respuesta, que utiliza al registrar su aplicación
    2. Seleccione Cuerpo de la solicitud en el menú Autorización de token.
    3. La URL de autorización se rellena automáticamente.
    4. La URL del token se rellena automáticamente.
    5. Compruebe que se ha introducido lo siguiente para el ámbito: user_read
    6. Introduzca su ID de cliente. El ID de cliente es la cadena que representa la información de registro del cliente exclusiva del servidor de autorización. Obtendrá este y el secreto al configurar el servidor de OAuth. Deberá agregar la URL de respuesta que aparece en la página de configuración de la integración.
    7. Introduzca su Secreto del cliente. El secreto del cliente es la cadena única emitida al configurar la integración de la aplicación de destino.

    Autenticación de servicio

  7. En Autenticación de acciones de servicio, habilite la opción Usar autenticación de usuario independiente en Acciones. La autenticación de acciones de servicio autentica en el nivel de acción de servicio. Las opciones de autenticación están preseleccionadas. Compruebe que estas opciones estén seleccionadas a medida que complete el proceso.

    1. En el menú Método de autenticación, seleccione OAuth 2.0 y complete los detalles de autenticación.
    2. Seleccione Código de autorización en el menú Tipo de concesión. De esta manera, se concede un código temporal que el cliente intercambia por un token de acceso. El código se obtiene del servidor de autorización, donde se puede ver la información que solicita el cliente. Solo este tipo de concesión permite la suplantación segura de usuarios. Se muestra la URL de respuesta, que utiliza al registrar su aplicación
    3. Seleccione Cuerpo de la solicitud en el menú Autorización de token.
    4. La URL de autorización se rellena automáticamente.
    5. La URL del token se rellena automáticamente.
    6. Compruebe que se ha introducido lo siguiente para el ámbito: user_write
    7. Introduzca su ID de cliente. El ID de cliente es la cadena que representa la información de registro del cliente exclusiva del servidor de autorización. Obtendrá este y el secreto al configurar el cliente de OAuth. Deberá agregar la URL de respuesta que aparece en la página de configuración de la integración.
    8. Introduzca su Secreto del cliente. El secreto del cliente es la cadena única emitida al configurar la integración de la aplicación de destino.

    Autenticación de acciones de servicio

  8. La opción Habilitar la limitación del índice de solicitudes está habilitada. Deje 400 como Cantidad de solicitudes y 1 minuto como Intervalo de tiempo. 1. El valor de Tiempo de espera de solicitud se establece en 120 de forma predeterminada.
  9. (Optativo) Habilite la opción Registro para conservar un registro de 24 horas con fines de asistencia.

    Autenticación de servicio

  10. Seleccione Guardar para continuar.
  11. En Autorización de OAuth, seleccione Autorizar para iniciar sesión con su cuenta de servicio. Aparecerá una ventana emergente con una pantalla de inicio de sesión de Google.
    1. Introduzca el nombre de usuario y la contraseña de su cuenta de servicio y seleccione Iniciar sesión.
    2. Seleccione Aceptar.

    Autorizar

Agregar acciones a botones

Configure acciones Ir a URL para los siguientes botones con el fin de habilitar las funciones de botón Firmar sobre y Ver sobre. Esta configuración de Ir a URL redirige la acción del usuario a la página de detalles del sobre específica en DocuSign.

  1. Desplácese al generador de páginas y, a continuación, seleccione los siguientes botones. Realice este procedimiento para cada botón siguiente:

    • Microaplicación: Mis sobres recibidos página: Detalles de sobre pendiente botón: Firmar sobre
    • Microaplicación: Mis sobres enviados página: Vista de destinatario del sobre botón: Firmar sobre
    • Microaplicación: Mis sobres enviados página: Vista de remitente del sobre botón: Firmar sobre
  2. Seleccione la ficha Acciones de la derecha.
  3. En Acciones, seleccione Ir a URL.
  4. En el campo Plantilla de URL, sustituya la sección {yourEnvironmentName} de la URL por la URL de entorno. Puede encontrar la URL de entorno en su URL base: https://{yourEnvironmentName}.docusign.net/restapi/v2.1/. Por ejemplo: https://appdemo.docusign.com/documents/details/\{\{nested_table_envelopes_recipients_sign.envelope_id\}\}.

    URL de entorno

  5. Ahora, repita este procedimiento para los otros botones.

Ya tiene todo listo para configurar y llevar a cabo su primera sincronización de datos. Para obtener información completa acerca de las reglas de sincronización, la sincronización que no cumple con sus reglas de programación y las reglas de veto, consulte Sincronizar datos.

Para obtener información detallada sobre los dispositivos de punto final de las API y las entidades de tabla, consulte Especificaciones del conector de DocuSign.

Usar microaplicaciones de DocuSign

Las integraciones de las aplicaciones existentes vienen con microaplicaciones de uso inmediato. Comience con estas microaplicaciones y personalícelas conforme a sus exigencias.

Nota:

Para habilitar las funciones de botón Firmar sobre y Ver sobre, debe sustituir el botón Acción de la página Detalles de sobre pendiente, la página Vista de destinatario del sobre y la página Vista de remitente del sobre por la URL de entorno. Consulte Agregar acciones a botones.

Mis sobres recibidos: Permite ver los sobres recibidos del usuario, que están en espera de firma. El usuario puede autenticarse y ver el sobre en DocuSign.

Notificación o página Flujos de trabajo por caso de uso
Página Mis sobres recibidos Proporciona una tabla con todos los sobres pendientes de firma por parte del usuario, con opción de búsqueda para filtrar los sobres por asunto de correo electrónico o nombre de los remitentes. Los usuarios pueden ver los sobres con estado “enviado” y “entregado”.
Página Detalles del sobre recibido Proporciona detalles de un sobre pendiente de firma, como el asunto del correo electrónico, el nombre del remitente y el tiempo hasta que caduque (número de días). Los usuarios pueden ver el sobre en Workspace mediante el botón Firmar sobre.
Página Firmar sobre Proporciona un formulario para firmar un sobre desde Citrix Workspace.

Enviar una plantilla: Permite enviar una plantilla para firma.

Notificación o página Flujos de trabajo por caso de uso
Página Seleccionar plantilla Proporciona una tabla con todas las plantillas del usuario. La integración no incluye plantillas compartidas en la lista de plantillas para el usuario que ha iniciado sesión.
Página Enviar plantilla Proporciona un formulario para enviar la plantilla a los destinatarios. El remitente proporciona los siguientes detalles para enviar un sobre: nombre, correo electrónico y rol. Los sobres se pueden enviar a un máximo de tres (3) destinatarios simultáneamente. Una plantilla debe contener un documento para poder enviar un sobre mediante esa plantilla.

Mis sobres enviados: Permite ver una lista de sobres enviados por el usuario. Los usuarios también pueden ver los detalles del sobre y agregar, modificar y eliminar destinatarios.

Nota:

Las notificaciones caducan dos días después de su creación.

Notificación o página Flujos de trabajo por caso de uso
Notificación de cambio de estado del sobre Cuando el estado de un sobre cambia a Completado o Rechazado, se genera una notificación y se envía al remitente del sobre. Si el estado de un sobre ya es Completado o Rechazado al agregar el registro a la base de datos de Citrix Microapps, no se genera la notificación para el remitente.
Notificación de nuevo sobre Cuando se recibe un nuevo sobre, el estado del sobre y del destinatario deben ser Enviado o Entregado, y se genera una notificación que se envía al destinatario asociado.
Página Agregar destinatario Proporciona un formulario para agregar un destinatario a un sobre. Contiene campos de entrada, como nombre, correo electrónico y rol.
Página Modificar destinatario Proporciona un formulario para modificar los campos de entrada, como nombre y correo electrónico. Cuando un usuario modifica un nombre o un correo electrónico, se muestra un botón Guardar y reenviar y se envía un correo electrónico al destinatario.
Página Detalles del sobre Proporciona detalles del sobre, como el asunto del correo electrónico, la fecha de creación y el estado. También muestra una lista de destinatarios asociados al sobre y un botón Agregar destinatario. Los usuarios no pueden modificar ni agregar destinatarios a los sobres anulados o rechazados.
Página Mis sobres enviados Proporciona una lista de todos los sobres enviados por el usuario que tienen un estado (enviado, entregado, completado, rechazado o anulado), con una barra de búsqueda para filtrar los sobres por asunto del correo electrónico o estado del sobre.
Página Detalles del destinatario Proporciona detalles del destinatario, como el nombre, el correo electrónico y el estado, además de botones para modificar el destinatario, reenviar el sobre y eliminar el destinatario.
Página Firmar sobre Proporciona detalles de un sobre pendiente de firma, como el asunto del correo electrónico, el nombre del remitente y el tiempo hasta que caduque (número de días). Los usuarios pueden ver el sobre en DocuSign mediante el botón Firmar sobre para firmarlo.
Página Ver sobre Proporciona detalles del sobre, como el asunto del correo electrónico, la fecha de creación y el estado. También contiene una lista de destinatarios asociados al sobre y un botón Ver sobre.
Integrar DocuSign