DocuSign

Usa el conector DocuSign para realizar operaciones de lectura en DocuSign.

Antes de comenzar

Antes de usar el conector de DocuSign, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en SIGUIENTE.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector (Connector): Selecciona DocuSign en la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de conexión no pueden superar los 49 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging. y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. De manera opcional, selecciona UseSandbox si usas una cuenta de zona de pruebas de DocuSign.
   8. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   9. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
   10. Haga clic en SIGUIENTE.
5. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de DocuSign admite los siguientes tipos de autenticación:

      • OAUTH 2.0: Código de autorización
      • OAuth 2.0: Portador de JWT

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haga clic en SIGUIENTE.
6. Revisa: Revisa tus detalles de conexión y autenticación.
7. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• OAUTH 2.0: Código de autorización
  • ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
  • Permisos: Es una lista de permisos deseados separados por comas.
  • Secreto de cliente: Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
• OAuth 2.0: portador de JWT
  • Clave de consumidor de app conectada:La clave de consumidor proporcionada para la app conectada que creaste.
  • Nombre de usuario: Es el nombre de usuario asociado con la app conectada que creaste.
  • Clave privada: El Secret de Secret Manager que incluye el contenido del archivo de clave privada. La clave privada debe coincidir con la clave o el certificado públicos que se proporcionan al conector.

Muestras de configuración de conexión

Esta sección enumera los valores de muestra para los diversos que configuras cuando creas la conexión.

OAUTH 2.0: Tipo de conexión del código de autorización

Nombre del campo	Detalles
Ubicación	us-central1
Conector	DocuSign
Versión del conector	1
Nombre de la conexión	gcp-docusign-new-auth
Habilita Cloud Logging	No
UseSandbox	Sí
Cuenta de servicio	[e-mail]
Autenticación	Código de autorización de OAuth 2.0
ID de cliente	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Permisos	firma
Secreto del cliente	CLIENT_SECRET
Versión del Secret	1

OAuth 2.0: Tipo de conexión de portador de JWT

Nombre del campo	Detalles
Ubicación	us-central1
Conector	DocuSign
Versión del conector	1
Nombre de la conexión	gcp-docusign-token
Habilita Cloud Logging	No
UseSandbox	Sí
Cuenta de servicio	[e-mail]
Autenticación	OAuth 2.0: portador de JWT
Clave de consumidor de app conectada	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nombre de usuario	USER_NAME
Clave privada	PRIVATE_KEY
Versión del Secret	1

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y una parámetro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. El esquema (metadatos) para entidades y acciones se recupera a través de la conexión en entorno de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se se reflejan automáticamente en tus conexiones existentes; debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualiza el esquema de conexión.

Limitaciones del sistema

El conector de DocuSign puede procesar 3 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, los conectores de integración asignan 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors se ajustará automáticamente de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para volúmenes grandes sin esperar al ajuste de escala automático, puedes ajustar el valor de nodo mínimo para una conexión. Se requieren más nodos para procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres un cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página para editar conexiones.
• Si estás basado en una suscripción comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar dependen de varios factores. Por lo tanto, antes de ajustar los nodos mínimos para obtener una mejor capacidad de procesamiento, te recomendamos que verifiques si tus sistemas de backend están configurados de manera óptima para controlar el tráfico requerido.

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

El valor de un ID de entidad debe pasarse directamente, como 16ab549b-95d7-47cb-b557-c2476ef62d9d. El ID 16ab549b-95d7-47cb-b557-c2476ef62d9d es el valor de clave primaria único que se debe pasar.

Ejemplo: Operación LIST para la entidad "Accounts"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Cuentas en la lista Entity.
3. Selecciona la operación LIST y, luego, haz clic en Listo.
4. sección Entrada de tarea de la tarea Conectores, puedes configurar la filterClause según tus requisitos.

Ejemplo: Operación LIST para la entidad "Documentos"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Documentos de la lista Entity.
3. Selecciona la operación LIST y, luego, haz clic en Listo.
4. Task Input de la tarea Connectors, puedes configurar filterClause según tus necesidades.

Ejemplo: Operación LIST para la entidad "Envelopes"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Sobres en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. sección Entrada de tarea de la tarea Conectores, puedes configurar la filterClause según tus requisitos.

Ejemplo: operación LIST para la entidad "Folders"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Carpetas en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. sección Entrada de tarea de la tarea Conectores, puedes configurar la filterClause según tus requisitos.

Ejemplo: Operación LIST para la entidad "Grupos"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Grupos en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. sección Entrada de tarea de la tarea Conectores, puedes configurar la filterClause según tus requisitos.

Ejemplo: Operación LIST para la entidad "Usuarios"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Usuarios de la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. sección Entrada de tarea de la tarea Conectores, puedes configurar la filterClause según tus requisitos.

También puedes realizar operaciones LIST en las siguientes entidades:

• UserInfo
• UserSignatures
• Lugares de trabajo
• Destinatarios
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Bloqueos
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Plantillas

Ejemplo: registro único GET para la entidad "Account"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Cuentas en la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. Para establecer el ID de la entidad, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 2.4578824E7 en el campo Input Value y elige EntityId como variable local.

Ejemplo: registro único GET para la entidad "Documents"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Documentos de la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. Para configurar la cláusula Filtro, en la sección Data Mapper de la Data Mapping, haz clic en Open Data Mapping Editor y Luego, ingresa Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' en el campo Input Value y elige la cláusula Filter como variable Local.

Ejemplo: Obtén un solo registro de la entidad "Envelopes"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Sobres en la lista Entity.
3. Selecciona la operación GET y, luego, haz clic en Listo.
4. Para establecer el ID de la entidad, en la sección Data Mapper de la Data Mapping, haz clic en Open Data Mapping Editor y Luego, ingresa 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 en el campo Input Value y elige la variable EntityId como Local.

Ejemplo: registro único GET para la entidad “Folders”

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Carpetas en la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. Para establecer el ID de la entidad, en la sección Data Mapper de la Data Mapping, haz clic en Open Data Mapping Editor y Luego, ingresa 05f76d13-a513-492b-8c58-176702768db0 en el campo Input Value y elige la variable EntityId como Local.

Ejemplo: registro único GET para "Grupos" de la entidad

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Grupos en la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. Para establecer el ID de la entidad, en la sección Data Mapper de la Data Mapping, haz clic en Open Data Mapping Editor y Luego, ingresa 1.4167231E7 en el campo Input Value y elige la variable EntityId como Local.

Ejemplo: Obtén un solo registro de la entidad "Usuarios"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Usuarios de la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. Para establecer el ID de la entidad, en la sección Data Mapper de Data Mapping, haz clic en Open Data Mapping Editor y, luego, ingresa 16ab549b-95d7-47cb-b557-c2476ef62d9d en el campo Input Value y elige EntityId como variable local.

También puedes realizar operaciones GET en las siguientes entidades:

• UserInfo
• UserSignatures
• Lugares de trabajo
• Destinatarios
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Bloqueos
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Plantillas

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se utiliza para autenticarse en el proxy ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user	STRING	Falso	Un nombre de usuario que se usará para autenticarse en el proxy ProxyServer.
proxy_password	SECRET	Falso	Es una contraseña que se usará para autenticarse en el proxy de ProxyServer.

Usa la conexión de DocuSign en una integración

Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
• Para comprender cómo crear y usar la tarea Connectors en la integración de aplicaciones, consulta Tarea Connectors.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información para suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Aprende a ver los registros del conector.