Certinal eSign (versión preliminar)
Certinal eSign permite a las empresas enviar, firmar y administrar documentos de forma segura con eSignatures compatibles globalmente. Diseñado para sectores regulados, Certinal proporciona seguimiento de flujos de trabajo en tiempo real, pistas de auditoría a prueba de alteraciones y automatización sin problemas. Use Certinal eSign en los flujos de trabajo para digitalizar aprobaciones, acelerar procesos y garantizar firmas válidas legalmente en más de 70 países.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Ayuda y soporte técnico |
| URL | https://www.certinal.com/department/esignature-for-support |
| Correo Electrónico | tech-support@certinal.com |
| Metadatos del conector | |
|---|---|
| Publicador | Certinal Inc. |
| Sitio web | https://www.certinal.com/ |
| Directiva de privacidad | https://www.certinal.com/privacy-policy |
| Categorías | Productividad; Gestión empresarial |
Certinal eSign
Información general
Certinal eSign proporciona flujos de trabajo seguros y compatibles con eSignature y eConsent para empresas globales: enviar, firmar, realizar un seguimiento y administrar documentos directamente desde Power Automate.
Prerrequisitos
Debe tener una cuenta de administrador de Certinal para poder usar el desencadenador del conector. Para usar el desencadenador del conector en esta integración, Power Connector debe estar habilitado en la configuración del administrador de Certinal.
Obtención de credenciales
Certinal usa la clave de API para autenticar los servicios. Debe generar la clave de API desde la cuenta de administrador de Certinal.
Operaciones admitidas
El conector admite las siguientes operaciones:
Obtener detalles de la transacción
Obtención de detalles de transacción por identificador de transacción
Descargar documentos para transacciones
Descargar documentos para un identificador de transacción determinado
Crear transacción
Crear transacción
Crear transacción mediante plantilla
Crear transacción mediante un identificador de plantilla determinado
Lista de usuarios
Lista de usuarios
Obtener detalles del usuario
Obtención de detalles del usuario para el identificador de usuario determinado
Crear usuario
Crear usuario
Desencadenadores admitidos
El conector admite los siguientes desencadenadores:
Cuando se cambia un estado de transacción
Registrar una devolución de llamada para un evento de transacción determinado
Documentos de API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Ayuda y soporte técnico
https://esign.certinal.com/esign/certinal-docs/help-support
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
| Punto de conexión de API base | cuerda / cadena | Dirección URL base del punto de conexión de API (por ejemplo, api.certinal.com) | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Crear transacción |
Crear transacción |
| Crear transacción mediante plantilla |
Crear transacción mediante un identificador de plantilla determinado |
| Crear usuario |
Crear usuario |
| Descargar documentos para transacciones |
Descargar documentos para un identificador de transacción determinado |
| Eliminar suscripción |
Eliminar suscripción |
| Lista de usuarios |
Lista de usuarios |
| Obtener detalles de la transacción |
Obtención de detalles de transacción por identificador de transacción |
| Obtener detalles del usuario |
Obtención de detalles del usuario para el identificador de usuario determinado |
Crear transacción
Crear transacción
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de transacción
|
name | True | string |
Nombre de transacción |
|
Message
|
message | string |
Mensaje para todos los participantes. |
|
|
Dirección URL de devolución de llamada
|
url | string |
Dirección URL de devolución de llamada |
|
|
Eventos de transacción
|
transactionEvents | array of string |
Eventos de transacción |
|
|
Eventos de participantes
|
participantEvents | array of string |
Eventos de participantes |
|
|
Estado de la transacción
|
status | string |
Estado de la transacción |
|
|
Id. externo
|
externalId | string |
Id. externo |
|
|
Expira en la marca de tiempo
|
expiresAtTimestamp | string |
La transacción expira en la marca de tiempo |
|
|
Recordar desde la marca de tiempo
|
remindFromTimestamp | string |
Recordar desde la marca de tiempo |
|
|
Frecuencia de recordatorio
|
reminderFrequency | integer |
Frecuencia de recordatorio |
|
|
Campos predeterminados
|
default | boolean |
Campos de bloque de firma predeterminados |
|
|
Secuencia de participantes
|
sequence | integer |
Sequence |
|
|
Rol
|
role | string |
Rol |
|
|
Nombre
|
name | string |
Nombre del candidato |
|
|
Dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico del candidato |
|
|
Language
|
language | string |
Language |
|
|
Modo de autenticación
|
authenticationMode | string |
Modo de autenticación |
|
|
Valor del modo de autenticación
|
authenticationModeValue | string |
Valor del modo de autenticación |
|
|
Canales de entrega
|
deliveryChannels | array of string |
Canales de entrega |
|
|
Id. de campo
|
fieldId | string |
Id. de campo |
|
|
Páginas
|
pages | array of string |
Páginas |
|
|
Id. de documento
|
documentId | string |
Id. de documento |
|
|
Ancho de campo
|
width | float |
Ancho de campo |
|
|
Alto del campo
|
height | float |
Alto del campo |
|
|
Botón de ayuda
|
tooltip | string |
Botón de ayuda |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Recuento de líneas de área de texto
|
textareaLineCount | string |
Recuento de líneas de área de texto |
|
|
Nombre del campo
|
fieldName | string |
Nombre del campo |
|
|
Posición X
|
xposition | float |
Posición X del campo |
|
|
Posición Y
|
yposition | float |
Posición Y del campo |
|
|
¿Es obligatorio?
|
required | boolean |
¿Es un campo obligatorio? |
|
|
¿Es de solo lectura?
|
readOnly | boolean |
¿Es un campo de solo lectura? |
|
|
Área de texto
|
textarea | boolean |
Área de texto |
|
|
Parte inferior superior
|
topBottom | boolean |
Parte inferior superior |
|
|
Vertical
|
vertical | boolean |
Vertical |
|
|
Id. de grupo de radio
|
radioGroupId | string |
Id. de grupo de radio |
|
|
Valor predeterminado
|
defaultValue | string |
Valor predeterminado |
|
|
Importancia
|
value | string |
Importancia |
|
|
Mostrar etiqueta
|
displayLabel | string |
Mostrar etiqueta |
|
|
Nombre
|
name | string |
Nombre |
|
|
Dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
|
Language
|
language | string |
Language |
|
|
Id. de documento
|
id | string |
Id. de documento |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
¿Es deletable?
|
deletable | boolean |
¿Es deletable? |
|
|
Es privado
|
private | boolean |
Es privado |
|
|
Valor de campo
|
value | string |
Valor de campo |
|
|
Nombre del campo
|
fieldName | string |
Nombre del campo |
|
|
Código
|
code | string |
Código |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Identificador de transacción
|
data.transactionId | string |
Identificador de transacción |
Crear transacción mediante plantilla
Crear transacción mediante un identificador de plantilla determinado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de transacción
|
name | string |
Nombre de transacción |
|
|
Estado de la transacción
|
status | string |
Estado de la transacción |
|
|
Id. externo
|
externalId | string |
Id. externo |
|
|
ID de plantilla
|
templateId | string |
ID de plantilla |
|
|
Id. de plantilla secundaria
|
secondaryTemplateIds | array of string |
Id. de plantilla secundaria |
|
|
Message
|
message | string |
Mensaje para todos los participantes. |
|
|
Dirección URL de devolución de llamada
|
url | string |
Dirección URL de devolución de llamada |
|
|
Eventos de transacción
|
transactionEvents | array of string |
Eventos de transacción |
|
|
Eventos de participantes
|
participantEvents | array of string |
Eventos de participantes |
|
|
Secuencia de participantes
|
sequence | integer |
Sequence |
|
|
Rol
|
role | string |
Rol |
|
|
¿Es proceso automático?
|
autoProcess | boolean |
¿Es proceso automático? |
|
|
Nombre del campo
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo
|
value | string |
Valor de campo |
|
|
Nombre
|
name | string |
Nombre del candidato |
|
|
Dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico del candidato |
|
|
Message
|
message | string |
Message |
|
|
Language
|
language | string |
Language |
|
|
Canales de entrega
|
deliveryChannels | array of string |
Canales de entrega |
|
|
Cuerpo de SMS personalizado
|
customSMSBody | string |
Cuerpo de SMS personalizado |
|
|
Nombre
|
name | string |
Nombre |
|
|
Message
|
message | string |
Message |
|
|
¿Es obligatorio?
|
required | boolean |
¿Es obligatorio? |
|
|
Nombre
|
name | string |
Nombre |
|
|
Dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
|
Language
|
language | string |
Language |
|
|
Valor de campo
|
value | string |
Valor de campo |
|
|
Nombre del campo
|
fieldName | string |
Nombre del campo |
|
|
Código
|
code | string |
Código |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Identificador de transacción
|
data.transactionId | string |
Identificador de transacción |
Crear usuario
Crear usuario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
|
Nombre
|
firstName | string |
Nombre |
|
|
Apellido
|
lastName | string |
Apellido |
|
|
Empresa
|
company | string |
Empresa |
|
|
Zona horaria
|
timezone | string |
Zona horaria |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
Título del Puesto
|
jobTitle | string |
Título del Puesto |
|
|
Número de teléfono
|
phoneNumber | string |
Número de teléfono |
|
|
Código de país
|
phoneCountryCode | string |
Código de país |
|
|
Funciones
|
roles | array of string |
Funciones |
|
|
¿Está deshabilitado el correo final?
|
finalMailDisabled | boolean |
¿Está deshabilitado el correo final? |
|
|
¿Está deshabilitado el correo de recordatorio?
|
reminderMailDisabled | boolean |
¿Está deshabilitado el correo de recordatorio? |
|
|
¿Está deshabilitado el correo del remitente?
|
senderMailDisabled | boolean |
¿Está deshabilitado el correo del remitente? |
|
|
¿Es usuario de integración?
|
integrationUser | boolean |
¿Es usuario de integración? |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Id. de usuario
|
data.user_id | string |
Id. de usuario |
Descargar documentos para transacciones
Descargar documentos para un identificador de transacción determinado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de transacción
|
transactionId | True | string |
Identificador de transacción único |
|
Tipo documento
|
documentType | True | string |
Tipo de documento que se va a descargar |
Devoluciones
- response
- file
Eliminar suscripción
Eliminar suscripción
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de webhook
|
webhookId | True | string |
Identificador único de la suscripción de webhook que se va a eliminar |
Lista de usuarios
Lista de usuarios
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de página
|
pageNo | True | integer | |
|
Registros por página
|
perPageRecords | True | integer |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Total de registros
|
data.totalRecords | integer |
total de registros |
|
Total de páginas
|
data.totalPages | integer |
Total de páginas |
|
Registros por página
|
data.perPageRecords | integer |
Registros por página |
|
Número de página
|
data.pageNo | integer |
Número de página |
|
Registros
|
data.records | array of object |
Registros de usuario |
|
Nombre
|
data.records.firstName | string |
Nombre |
|
Apellido
|
data.records.lastName | string |
Apellido |
|
Empresa
|
data.records.company | string |
Empresa |
|
Zona horaria
|
data.records.timezone | string |
Zona horaria |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Título del Puesto
|
data.records.jobTitle | string |
Título del Puesto |
|
Número de teléfono
|
data.records.phoneNumber | string |
Número de teléfono |
|
Código de país
|
data.records.phoneCountryCode | string |
Código de país |
|
Funciones
|
data.records.roles | array of string |
Funciones |
|
¿Está deshabilitado el correo final?
|
data.records.finalMailDisabled | boolean |
¿Está deshabilitado el correo final? |
|
¿Está deshabilitado el correo de recordatorio?
|
data.records.reminderMailDisabled | boolean |
¿Está deshabilitado el correo de recordatorio? |
|
¿Está deshabilitado el correo del remitente?
|
data.records.senderMailDisabled | boolean |
¿Está deshabilitado el correo del remitente? |
|
¿Es usuario de integración?
|
data.records.integrationUser | boolean |
¿Es usuario de integración? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
Está activo
|
data.records.active | boolean |
Está activo |
|
Id
|
data.records.id | string |
Id |
|
Dirección de correo electrónico
|
data.records.emailAddress | string |
Dirección de correo electrónico |
Obtener detalles de la transacción
Obtención de detalles de transacción por identificador de transacción
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de transacción
|
transactionId | True | string |
Identificador de transacción único |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nombre de transacción
|
data.name | string |
Nombre de transacción |
|
Estado de la transacción
|
data.status | string |
Estado de la transacción |
|
Identificador de transacción
|
data.transactionId | string |
Identificador de transacción |
|
Message
|
data.mail.message | string |
Mensaje para todos los participantes. |
|
Fecha de última actualización
|
data.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.createdDate | string |
Fecha de creación |
|
Id. de usuario
|
data.createdBy.id | string |
Creado por identificador de usuario |
|
Nombre de usuario
|
data.createdBy.username | string |
Creado por nombre de usuario |
|
Dirección de correo electrónico
|
data.createdBy.emailAddress | string |
Creado por dirección de correo electrónico |
|
Fecha de envío
|
data.sentDate | string |
Fecha de envío |
|
Id. de usuario
|
data.lastActionPerformedBy.userId | string |
Id. de usuario |
|
Nombre de usuario
|
data.lastActionPerformedBy.userName | string |
Nombre de usuario |
|
Dirección de correo electrónico
|
data.lastActionPerformedBy.emailAddress | string |
Dirección de correo electrónico |
|
Id. de candidato
|
data.lastActionPerformedBy.candidateId | string |
Id. de candidato |
|
Id. de participante
|
data.lastActionPerformedBy.participantId | string |
Id. de participante |
|
Expira en la marca de tiempo
|
data.expiryAndReminders.expiresAtTimestamp | string |
La transacción expira en la marca de tiempo |
|
Días de expiración
|
data.expiryAndReminders.expiryDays | integer |
Días de expiración |
|
Recordar desde días de recordatorio
|
data.expiryAndReminders.remindFromReminderDays | integer |
Recordar desde días de recordatorio |
|
Recordar desde la hora del recordatorio
|
data.expiryAndReminders.remindFromReminderTime | string |
Recordar desde la hora del recordatorio |
|
Frecuencia de recordatorio
|
data.expiryAndReminders.reminderFrequency | integer |
Frecuencia de recordatorio |
|
Participantes
|
data.participants | array of object |
Participantes |
|
Id. de participante
|
data.participants.id | string |
Id. de participante |
|
Estado del participante
|
data.participants.status | string |
Estado del participante |
|
Fecha de última actualización
|
data.participants.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.participants.createdDate | string |
Fecha de creación |
|
Secuencia de participantes
|
data.participants.sequence | integer |
Sequence |
|
Rol
|
data.participants.role | string |
Rol |
|
Método de firma
|
data.participants.signingMethodDTO | array of string |
Detalles del método de firma |
|
Enviado por usuario
|
data.participants.submittedBys | array of object |
Enviados por los detalles del usuario |
|
Id. de usuario
|
data.participants.submittedBys.userId | string |
Enviado por identificador de usuario |
|
Nombre de usuario
|
data.participants.submittedBys.userName | string |
Enviado por nombre de usuario |
|
Dirección de correo electrónico
|
data.participants.submittedBys.emailAddress | string |
Enviado por dirección de correo electrónico del usuario |
|
Id. de candidato
|
data.participants.submittedBys.candidateId | string |
Id. de candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
Id. de candidato
|
data.participants.candidates.id | string |
Id. de candidato |
|
Nombre
|
data.participants.candidates.name | string |
Nombre del candidato |
|
Dirección de correo electrónico
|
data.participants.candidates.emailAddress | string |
Dirección de correo electrónico del candidato |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Tipo
|
data.participants.candidates.type | string |
Tipo |
|
Acción
|
data.participants.candidates.action | string |
Acción |
|
Fecha de acción
|
data.participants.candidates.actionDate | string |
Fecha de acción |
|
Fecha de creación
|
data.participants.candidates.createdDate | string |
Fecha de creación |
|
Valor del modo de autenticación
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valor del modo de autenticación |
|
detalles del método de firma
|
data.participants.candidates.signingMethodDTO | array of string |
detalles del método de firma |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canales de entrega
|
data.participants.candidates.deliveryChannels | array of string |
Canales de entrega |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
Fecha de última actualización
|
data.participants.fields.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.participants.fields.createdDate | string |
Fecha de creación |
|
Id. de campo
|
data.participants.fields.fieldId | string |
Id. de campo |
|
Página No
|
data.participants.fields.pageNo | integer |
Página No |
|
Id. de documento
|
data.participants.fields.documentId | string |
Id. de documento |
|
Ancho de campo
|
data.participants.fields.width | float |
Ancho de campo |
|
Alto del campo
|
data.participants.fields.height | float |
Alto del campo |
|
Botón de ayuda
|
data.participants.fields.tooltip | string |
Botón de ayuda |
|
Importancia
|
data.participants.fields.value | string |
Importancia |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Mostrar etiqueta
|
data.participants.fields.displayLabel | string |
Mostrar etiqueta |
|
Tipo de vínculo
|
data.participants.fields.linkType | string |
Tipo de vínculo |
|
Id. de radio
|
data.participants.fields.radioId | integer |
Id. de radio |
|
Id. de grupo de radio
|
data.participants.fields.radioGroupId | string |
Id. de grupo de radio |
|
Identificador de casilla
|
data.participants.fields.checkboxId | integer |
Identificador de casilla |
|
Nombre del campo
|
data.participants.fields.fieldName | string |
Nombre del campo |
|
Posición X
|
data.participants.fields.xposition | float |
Posición X del campo |
|
Posición Y
|
data.participants.fields.yposition | float |
Posición Y del campo |
|
¿Es obligatorio?
|
data.participants.fields.required | boolean |
¿Es un campo obligatorio? |
|
¿Es de solo lectura?
|
data.participants.fields.readOnly | boolean |
¿Es un campo de solo lectura? |
|
Área de texto
|
data.participants.fields.textarea | boolean |
Área de texto |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Parte inferior superior
|
data.participants.fields.topBottom | boolean |
Parte inferior superior |
|
Valor predeterminado
|
data.participants.fields.defaultValue | string |
Valor predeterminado |
|
Formato
|
data.participants.signatureBlock.format | array of object |
Formato |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
¿Es obligatorio?
|
data.participants.signatureBlock.format.required | boolean |
¿Es obligatorio? |
|
Predeterminado
|
data.participants.signatureBlock.default | boolean |
Predeterminado |
|
Habilitar delegado
|
data.participants.enableDelegate | boolean |
Habilitar delegado |
|
Proceso automático
|
data.participants.autoProcess | boolean |
Proceso automático |
|
Usuarios cc
|
data.ccUsers | array of object |
Usuarios cc |
|
Nombre
|
data.ccUsers.name | string |
Nombre |
|
Dirección de correo electrónico
|
data.ccUsers.emailAddress | string |
Dirección de correo electrónico |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documentos
|
data.documents | array of object |
Documentos |
|
Id. de documento
|
data.documents.id | string |
Id. de documento |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nombre de archivo
|
data.documents.fileName | string |
Nombre de archivo |
|
Recuento de páginas
|
data.documents.pageCount | integer |
Recuento de páginas |
|
¿Es deletable?
|
data.documents.deletable | boolean |
¿Es deletable? |
|
Es privado
|
data.documents.private | boolean |
Es privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
Identificador de campo personalizado
|
data.customFields.customFieldId | string |
Identificador de campo personalizado |
|
Valor de campo
|
data.customFields.value | string |
Valor de campo |
|
Nombre del campo
|
data.customFields.fieldName | string |
Nombre del campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Suscripciones de notificación
|
data.notificationSubscriptions | array of |
Suscripciones de notificación |
|
tags
|
data.tags | array of |
tags |
|
Documentos adicionales
|
data.additionalDocuments | array of object |
Documentos adicionales |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nombre de archivo
|
data.additionalDocuments.fileName | string |
Nombre de archivo |
|
Tipo
|
data.additionalDocuments.type | string |
Tipo |
|
Id. de candidato
|
data.additionalDocuments.candidateId | string |
Id. de candidato |
|
Contratos independientes
|
data.separateAgreements | boolean |
Contratos independientes |
Obtener detalles del usuario
Obtención de detalles del usuario para el identificador de usuario determinado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
userId | True | string |
Identificador de usuario único |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nombre
|
data.firstName | string |
Nombre |
|
Apellido
|
data.lastName | string |
Apellido |
|
Empresa
|
data.company | string |
Empresa |
|
Zona horaria
|
data.timezone | string |
Zona horaria |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Título del Puesto
|
data.jobTitle | string |
Título del Puesto |
|
Número de teléfono
|
data.phoneNumber | string |
Número de teléfono |
|
Código de país
|
data.phoneCountryCode | string |
Código de país |
|
Funciones
|
data.roles | array of string |
Funciones |
|
¿Está deshabilitado el correo final?
|
data.finalMailDisabled | boolean |
¿Está deshabilitado el correo final? |
|
¿Está deshabilitado el correo de recordatorio?
|
data.reminderMailDisabled | boolean |
¿Está deshabilitado el correo de recordatorio? |
|
¿Está deshabilitado el correo del remitente?
|
data.senderMailDisabled | boolean |
¿Está deshabilitado el correo del remitente? |
|
¿Es usuario de integración?
|
data.integrationUser | boolean |
¿Es usuario de integración? |
|
Salutation
|
data.salutation | string |
Salutation |
|
Está activo
|
data.active | boolean |
Está activo |
|
Id
|
data.id | string |
Id |
|
Dirección de correo electrónico
|
data.emailAddress | string |
Dirección de correo electrónico |
Desencadenadores
| Cuando se cambia un estado de transacción |
Registrar una devolución de llamada para un evento de transacción determinado |
Cuando se cambia un estado de transacción
Registrar una devolución de llamada para un evento de transacción determinado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de evento
|
eventType | True | array |
Tipo de evento de transacción para el que se va a registrar |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Marca de tiempo
|
timestamp | integer |
Marca de tiempo |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nombre de transacción
|
data.name | string |
Nombre de transacción |
|
Estado de la transacción
|
data.status | string |
Estado de la transacción |
|
Identificador de transacción
|
data.transactionId | string |
Identificador de transacción |
|
Message
|
data.mail.message | string |
Mensaje para todos los participantes. |
|
Fecha de última actualización
|
data.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.createdDate | string |
Fecha de creación |
|
Id. de usuario
|
data.createdBy.id | string |
Creado por identificador de usuario |
|
Nombre de usuario
|
data.createdBy.username | string |
Creado por nombre de usuario |
|
Dirección de correo electrónico
|
data.createdBy.emailAddress | string |
Creado por dirección de correo electrónico |
|
Fecha de envío
|
data.sentDate | string |
Fecha de envío |
|
Id. de usuario
|
data.lastActionPerformedBy.userId | string |
Id. de usuario |
|
Nombre de usuario
|
data.lastActionPerformedBy.userName | string |
Nombre de usuario |
|
Dirección de correo electrónico
|
data.lastActionPerformedBy.emailAddress | string |
Dirección de correo electrónico |
|
Id. de candidato
|
data.lastActionPerformedBy.candidateId | string |
Id. de candidato |
|
Id. de participante
|
data.lastActionPerformedBy.participantId | string |
Id. de participante |
|
Expira en la marca de tiempo
|
data.expiryAndReminders.expiresAtTimestamp | string |
La transacción expira en la marca de tiempo |
|
Días de expiración
|
data.expiryAndReminders.expiryDays | integer |
Días de expiración |
|
Recordar desde días de recordatorio
|
data.expiryAndReminders.remindFromReminderDays | integer |
Recordar desde días de recordatorio |
|
Recordar desde la hora del recordatorio
|
data.expiryAndReminders.remindFromReminderTime | string |
Recordar desde la hora del recordatorio |
|
Frecuencia de recordatorio
|
data.expiryAndReminders.reminderFrequency | integer |
Frecuencia de recordatorio |
|
Participantes
|
data.participants | array of object |
Participantes |
|
Id. de participante
|
data.participants.id | string |
Id. de participante |
|
Estado del participante
|
data.participants.status | string |
Estado del participante |
|
Fecha de última actualización
|
data.participants.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.participants.createdDate | string |
Fecha de creación |
|
Secuencia de participantes
|
data.participants.sequence | integer |
Sequence |
|
Rol
|
data.participants.role | string |
Rol |
|
Método de firma
|
data.participants.signingMethodDTO | array of string |
Detalles del método de firma |
|
Enviado por usuario
|
data.participants.submittedBys | array of object |
Enviados por los detalles del usuario |
|
Id. de usuario
|
data.participants.submittedBys.userId | string |
Enviado por identificador de usuario |
|
Nombre de usuario
|
data.participants.submittedBys.userName | string |
Enviado por nombre de usuario |
|
Dirección de correo electrónico
|
data.participants.submittedBys.emailAddress | string |
Enviado por dirección de correo electrónico del usuario |
|
Id. de candidato
|
data.participants.submittedBys.candidateId | string |
Id. de candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
Id. de candidato
|
data.participants.candidates.id | string |
Id. de candidato |
|
Nombre
|
data.participants.candidates.name | string |
Nombre del candidato |
|
Dirección de correo electrónico
|
data.participants.candidates.emailAddress | string |
Dirección de correo electrónico del candidato |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Tipo
|
data.participants.candidates.type | string |
Tipo |
|
Acción
|
data.participants.candidates.action | string |
Acción |
|
Fecha de acción
|
data.participants.candidates.actionDate | string |
Fecha de acción |
|
Fecha de creación
|
data.participants.candidates.createdDate | string |
Fecha de creación |
|
Valor del modo de autenticación
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valor del modo de autenticación |
|
detalles del método de firma
|
data.participants.candidates.signingMethodDTO | array of string |
detalles del método de firma |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canales de entrega
|
data.participants.candidates.deliveryChannels | array of string |
Canales de entrega |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
Fecha de última actualización
|
data.participants.fields.lastUpdatedDate | string |
Fecha de última actualización |
|
Fecha de creación
|
data.participants.fields.createdDate | string |
Fecha de creación |
|
Id. de campo
|
data.participants.fields.fieldId | string |
Id. de campo |
|
Página No
|
data.participants.fields.pageNo | integer |
Página No |
|
Id. de documento
|
data.participants.fields.documentId | string |
Id. de documento |
|
Ancho de campo
|
data.participants.fields.width | float |
Ancho de campo |
|
Alto del campo
|
data.participants.fields.height | float |
Alto del campo |
|
Botón de ayuda
|
data.participants.fields.tooltip | string |
Botón de ayuda |
|
Importancia
|
data.participants.fields.value | string |
Importancia |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Mostrar etiqueta
|
data.participants.fields.displayLabel | string |
Mostrar etiqueta |
|
Tipo de vínculo
|
data.participants.fields.linkType | string |
Tipo de vínculo |
|
Id. de radio
|
data.participants.fields.radioId | integer |
Id. de radio |
|
Id. de grupo de radio
|
data.participants.fields.radioGroupId | string |
Id. de grupo de radio |
|
Identificador de casilla
|
data.participants.fields.checkboxId | integer |
Identificador de casilla |
|
Nombre del campo
|
data.participants.fields.fieldName | string |
Nombre del campo |
|
Posición X
|
data.participants.fields.xposition | float |
Posición X del campo |
|
Posición Y
|
data.participants.fields.yposition | float |
Posición Y del campo |
|
¿Es obligatorio?
|
data.participants.fields.required | boolean |
¿Es un campo obligatorio? |
|
¿Es de solo lectura?
|
data.participants.fields.readOnly | boolean |
¿Es un campo de solo lectura? |
|
Área de texto
|
data.participants.fields.textarea | boolean |
Área de texto |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Parte inferior superior
|
data.participants.fields.topBottom | boolean |
Parte inferior superior |
|
Valor predeterminado
|
data.participants.fields.defaultValue | string |
Valor predeterminado |
|
Formato
|
data.participants.signatureBlock.format | array of object |
Formato |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
¿Es obligatorio?
|
data.participants.signatureBlock.format.required | boolean |
¿Es obligatorio? |
|
Predeterminado
|
data.participants.signatureBlock.default | boolean |
Predeterminado |
|
Habilitar delegado
|
data.participants.enableDelegate | boolean |
Habilitar delegado |
|
Proceso automático
|
data.participants.autoProcess | boolean |
Proceso automático |
|
Usuarios cc
|
data.ccUsers | array of object |
Usuarios cc |
|
Nombre
|
data.ccUsers.name | string |
Nombre |
|
Dirección de correo electrónico
|
data.ccUsers.emailAddress | string |
Dirección de correo electrónico |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documentos
|
data.documents | array of object |
Documentos |
|
Id. de documento
|
data.documents.id | string |
Id. de documento |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nombre de archivo
|
data.documents.fileName | string |
Nombre de archivo |
|
Recuento de páginas
|
data.documents.pageCount | integer |
Recuento de páginas |
|
¿Es deletable?
|
data.documents.deletable | boolean |
¿Es deletable? |
|
Es privado
|
data.documents.private | boolean |
Es privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
Identificador de campo personalizado
|
data.customFields.customFieldId | string |
Identificador de campo personalizado |
|
Valor de campo
|
data.customFields.value | string |
Valor de campo |
|
Nombre del campo
|
data.customFields.fieldName | string |
Nombre del campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Suscripciones de notificación
|
data.notificationSubscriptions | array of |
Suscripciones de notificación |
|
tags
|
data.tags | array of |
tags |
|
Documentos adicionales
|
data.additionalDocuments | array of object |
Documentos adicionales |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nombre de archivo
|
data.additionalDocuments.fileName | string |
Nombre de archivo |
|
Tipo
|
data.additionalDocuments.type | string |
Tipo |
|
Id. de candidato
|
data.additionalDocuments.candidateId | string |
Id. de candidato |
|
Contratos independientes
|
data.separateAgreements | boolean |
Contratos independientes |
Definiciones
archivo
Este es el tipo de datos básico "file".