DocuSign

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra para los distintos campos que configuras cuando creas la conexión.

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

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

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.

• 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, esas operaciones no admitidas no se incluirán 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. Por lo general, 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.

Acciones

En esta sección, se enumeran todas las acciones que admite la conexión de DocuSign.

Acción CreateAndSendEnvelope

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

Parámetros de entrada de la acción CreateAndSendEnvelope

Para ver ejemplos sobre 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 en 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. Selecciona la acción CreateAndSendEnvelope y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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"
   }
   

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 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 haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según tus requisitos.

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 haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según tus requisitos.

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 haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer 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 Folders en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según tus requisitos.

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 haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer 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 en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Connectors, puedes establecer la filterClause según tus requisitos.

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

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

Ejemplo: GET de un solo registro 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 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: GET de un solo registro 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 haz clic en Listo.
4. Para configurar la cláusula de filtro, en la sección Data Mapper de 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 de filtro como variable local.

Ejemplo: GET de un solo registro para la entidad "Sobres"

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 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 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 en el campo Input Value y elige EntityId como variable local.

Ejemplo: GET de un solo registro para la entidad "Folders"

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Folders 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 05f76d13-a513-492b-8c58-176702768db0 en el campo Input Value y elige EntityId como variable local.

Ejemplo: GET de un solo registro 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 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 1.4167231E7 en el campo Input Value y elige EntityId como variable local.

Ejemplo: GET de un solo registro para la entidad "Usuarios"

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 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
• Cerraduras
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Plantillas