DocuSign

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

Antes de empezar

Antes de usar el conector de DocuSign, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

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

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

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

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

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

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. También puedes seleccionar UseSandbox si usas una cuenta de entorno aislado de DocuSign.
    8. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    9. También puedes hacer clic en + AÑADIR ETIQUETA para añadir una etiqueta a la conexión en forma de par clave-valor.
    10. Haz clic en SIGUIENTE.
  5. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

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

      • OAUTH 2.0: código de autorización
      • OAuth 2.0 - JWT Bearer
    2. Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    3. Haz clic en SIGUIENTE.
  6. Revisar: revisa los detalles de la conexión y la autenticación.
  7. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • OAUTH 2.0 - Código de autorización
    • ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
    • Scopes: lista separada por comas de los permisos deseados.
    • Secreto de cliente: secreto de Secret Manager que contiene el secreto de cliente de la aplicación conectada que has creado.
  • OAuth 2.0 - JWT Bearer
    • Clave de consumidor de la aplicación conectada: la clave de consumidor proporcionada para la aplicación conectada que has creado.
    • Nombre de usuario: el nombre de usuario asociado a la aplicación conectada que has creado.
    • Clave privada: secreto de Secret Manager que contiene el contenido del archivo de clave privada. La clave privada debe coincidir con la clave pública o el certificado proporcionado al conector.

Ejemplos de configuración de conexiones

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión.

OAUTH 2.0 - Tipo de conexión de 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
Habilitar Cloud Logging No
UseSandbox
Cuenta de servicio SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticación OAuth 2.0: código de autorización
ID de cliente 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Ámbitos signature
Secreto de cliente CLIENT_SECRET
Versión de secreto 1

Tipo de conexión OAuth 2.0 - JWT Bearer

Nombre del campo Detalles
Ubicación us-central1
Conector DocuSign
Versión del conector 1
Nombre de la conexión gcp-docusign-token
Habilitar Cloud Logging No
UseSandbox
Cuenta de servicio SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticación OAuth 2.0 - JWT Bearer
Clave de consumidor de la aplicación conectada 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nombre de usuario USER_NAME
Clave privada PRIVATE_KEY
Versión de secreto 1

Entidades, operaciones y acciones

Todos los conectores de integración 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 te muestra como entidades, operaciones y acciones.

  • Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

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

  • Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

  • Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de DocuSign puede procesar 3 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

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

Acciones

En esta sección se enumeran todas las acciones admitidas por la conexión de DocuSign.

Acción CreateAndSendEnvelope

Crea y envía un sobre o crea un borrador de sobre.

Parámetros de entrada de la acción CreateAndSendEnvelope

Nombre del parámetro Tipo de datos Obligatorio Descripción
FileName Cadena El nombre del documento.
DocumentId Cadena ID del documento.
EmailSubject Cadena El asunto del correo.
Contenido Cadena El contenido del archivo.
SignersEmail Cadena No Los IDs de correo de los firmantes del documento.
SignersRecipientId Cadena No Los IDs de destinatario de los firmantes.
CcRecipientId Cadena No Los IDs de los destinatarios que se han copiado en el correo.
CcEmail Cadena No Los IDs de correo de los destinatarios que se copian en el correo.
Estado Cadena No El estado del sobre. Define el estado como "Enviado" para enviar el sobre a los destinatarios.
CustomFieldAggregate Cadena No Puede usar las siguientes columnas: CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfiguration y CustomFieldListItems.
SignersName Cadena No Nombre de los firmantes del documento.
CcName Cadena No Nombre de los destinatarios de la copia.

Para ver un ejemplo de cómo configurar la acción CreateAndSendEnvelope, consulta Ejemplos.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: CreateAndSendEnvelope

Esta acción crea y envía un sobre o crea un borrador de sobre.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción CreateAndSendEnvelope y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:
    {
    "EmailSubject": "Please Sign this Document",
    "FileName": "test.txt\ntest.pdf",
    "SignersEmail": "cloudysanfrancisco@gmail.com",
    "SignersRecipientId": "53386460",
    "CcRecipientId": "67173451",
    "CcEmail": "baklavainthebalkans@gmail.com",
    "DocumentId": "1",
    "Status": "sent",
    "CustomFieldAggregate": "CustomFieldName",
    "ContentBytes": "abcd***",
    "HasBytes": true,
    "SignersName": "\"test\"",
    "CcName": "\"test\"",
    "Content": "test content in file"
    }
    
  4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

     [{
    "Success":"true",
    "envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
    "uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
    "statusdatetime":"2025-04-09T12:33:47.1130000Z",
    "status":"sent",
    "customfieldaggregate": "CustomFieldName"
    }]

Ejemplos de operaciones de entidades

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

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

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Seleccione Cuentas en la lista Entity.
  3. Selecciona la operación LIST y, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Documentos en la lista Entity.
  3. Selecciona la operación LIST y, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus 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 Envelopes en la lista Entity.
  3. Selecciona la operación LIST y, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

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, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

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

  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, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

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

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Usuarios en la lista Entity.
  3. Selecciona la operación LIST y, a continuación, haz clic en Hecho.
  4. Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

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

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

Ejemplo: GET de un solo registro de la entidad "Accounts"

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Seleccione Cuentas en la lista Entity.
  3. Selecciona la operación GET y, a continuación, haz clic en Hecho.
  4. Para definir el ID de entidad, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 2.4578824E7 en el campo Valor de entrada y elija EntityId como variable local.

Ejemplo: GET de un solo registro de la entidad "Documents"

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Documentos en la lista Entity.
  3. Selecciona la operación LIST y, a continuación, haz clic en Hecho.
  4. Para definir la cláusula de filtro, en la sección Asignación de datos de Asignador de datos, haz clic en Abrir editor de asignación de datos y, a continuación, introduce Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' en el campo Valor de entrada y elige la cláusula de filtro como variable local.

Ejemplo: GET de un solo registro de la entidad "Envelopes"

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Envelopes en la lista Entity.
  3. Selecciona la operación GET y, a continuación, haz clic en Hecho.
  4. Para definir el ID de entidad, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 en el campo Valor de entrada y elija EntityId como variable local.

Ejemplo: GET de un solo registro de 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, a continuación, haz clic en Hecho.
  4. Para definir el ID de entidad, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 05f76d13-a513-492b-8c58-176702768db0 en el campo Valor de entrada y elija EntityId como variable local.

Ejemplo: GET de un solo registro de la entidad "Groups"

  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, a continuación, haz clic en Hecho.
  4. Para definir el ID de entidad, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 1.4167231E7 en el campo Valor de entrada y elija EntityId como variable local.

Ejemplo: GET de un solo registro de la entidad "Users"

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Usuarios en la lista Entity.
  3. Selecciona la operación GET y, a continuación, haz clic en Hecho.
  4. Para definir el ID de entidad, en la sección Asignador de datos de Asignación de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 16ab549b-95d7-47cb-b557-c2476ef62d9d en el campo Valor de entrada y elija EntityId como variable local.

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

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

Crear conexiones con Terraform

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

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
proxy_enabled BOOLEAN Falso Seleccione esta casilla para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Tipo de autenticación que se usará para autenticar el proxy ProxyServer. Los valores posibles son: BASIC, DIGEST y NONE.
proxy_user STRING Falso Nombre de usuario que se usará para autenticar el proxy ProxyServer.
proxy_password SECRET Falso Contraseña que se usará para autenticarse en el proxy ProxyServer.

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

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos