Compartir a través de

GetAccept

GetAccept proporciona una plataforma de habilitación de ventas para que las ventas diseñen, envíen, promuevan, realicen un seguimiento y firmen documentos de ventas, aprovechando el material de ventas, la administración de contratos, las propuestas y las firmas electrónicas en un solo lugar.

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 GetAccept API Team
URL https://app.getaccept.com/api
Correo Electrónico integrations@getaccept.com
Metadatos del conector
Publicador GetAccept, Inc.
Sitio web https://www.getaccept.com
Directiva de privacidad https://www.getaccept.com/privacy-policy
Categorías Ventas y CRM; Productividad

GetAccept proporciona una plataforma de habilitación de ventas para que las ventas diseñen, envíen, promuevan, realicen un seguimiento y firmen documentos de ventas, aprovechando el material de ventas, la administración de contratos, las propuestas y las firmas electrónicas en un solo lugar. Este conector ayuda a automatizar los flujos de trabajo para el almacenamiento de documentos, la recuperación, la asignación de tareas y las notificaciones personalizadas.

Prerrequisitos

Se requiere una cuenta getAccept para usar esta conexión. Vaya a getaccept.com para registrar una cuenta gratuita.

¿Cómo obtener credenciales?

Solo se requiere una cuenta válida de GetAccept, ya que OAuth2 se usa para autenticar al usuario que ha iniciado sesión en GetAccept.

Problemas y limitaciones conocidos

Póngase en contacto con nuestro [mailto:support@getaccept.com](soporte técnico) para ver cualquier problema relacionado con la integración.

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualización de la expiración del documento

Use este método para actualizar la fecha y hora de expiración de un documento.
Carga de un archivo de documento

Puede cargar un archivo cada vez y obtener un identificador de archivo. El identificador de archivo se usa para conectar un archivo con un documento GetAccept que se envía a los destinatarios. Si desea cargar archivos de mutliple, ejecute varias post. Solo aceptamos archivos de hasta 10 MB como valor predeterminado. El archivo cargado debe importarse o agregarse a un documento en un plazo de 48 horas después de la carga.

Se recomienda cargar archivos PDF con el fin de garantizar el mismo aspecto cuando se envía. Otros tipos de archivo se pueden convertir, como:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Cargar datos adjuntos

Puede cargar archivos adjuntos para incluirlos con documentos que envíe. La solicitud correcta devolverá el attachment_id. Use attachment_id para asignar datos adjuntos a un documento.
Cargar un vídeo

Puede cargar archivos adjuntos para incluirlos con documentos que envíe. La solicitud correcta devolverá el attachment_id. Use attachment_id para asignar datos adjuntos a un documento.
Creación de un usuario

Esto creará un nuevo contacto en la base de datos para la entidad actual.
Creación y envío de documentos o plantillas

Debe crear un documento para poder enviarlo a un destinatario. Al crear un documento, puede hacer referencia a archivos cargados previamente con file_id o puede optar por crear un documento y cargar los archivos en la publicación de API. Solo puede cargar un archivo ONE al incluir un archivo en el documento de creación POST.

Use file_ids parámetro para usar archivos cargados existentes file_content para enviar el documento como cadena codificada en base64 o realizar una publicación de varias partes con el parámetro file.

Todos los destinatarios deben tener un correo electrónico válido o un número de móvil.

Todos los eventos se registran mediante la dirección IP del solicitante. Puede invalidar esto mediante el encabezado CLIENT_IP que contiene la dirección IP pública de los usuarios finales.
Crear contacto

Esto creará un nuevo contacto en la base de datos para la entidad actual.
Descargar documento

El archivo de documento siempre se puede descargar, pero lo más probable es que quiera descargarlo cuando tenga el estado Firmado.

Puede seleccionar recibir una dirección URL de descarga o obtener el archivo binario.

La dirección URL de descarga se puede acceder a 10 minutos después de realizar una solicitud.
Enumerar contactos

Reciba una lista de contactos disponibles para la entidad actual. Todos los contactos agregados como destinatarios se guardan como un contacto y están disponibles para su uso posterior en esa entidad.
Enumerar datos adjuntos

Reciba una lista de datos adjuntos disponibles. Puede agregar nuevos datos adjuntos en GetAccept mediante un nuevo documento.
Enumerar documentos

Obtener una lista de documentos disponibles
Enumerar usuarios

Captura de una lista de usuarios activos para la entidad autenticada actual
Enumerar vídeos

Reciba una lista de vídeos disponibles en la entidad. Puede agregar nuevos vídeos en la aplicación móvil o dentro de GetAccept.
Envío de un documento existente

Al enviar un documento a través de GetAccept, entregamos un correo electrónico a todos los destinatarios, cada uno que contiene un vínculo único y protegido. Esta llamada API desencadena la acción de envío del documento y solo se puede realizar en documentos con document_status = borrador. El documento se enviará a los destinatarios que proporcionó cuando se creó.

Si el documento se creó con la opción autofirmado, también será autofirmado por el usuario autenticado o especificado antes de enviarlo.
Obtención de destinatarios de documentos

Obtener una lista de destinatarios para un documento específico.
Obtención de detalles del usuario

Esta llamada devolverá los detalles de un solo usuario. Recibir detalles y entidades disponibles del usuario autenticado actual mediante user-id me
Obtención de roles de plantilla

Reciba una lista de roles para una plantilla específica.
Obtención de tablas de precios de plantillas

Reciba una lista de elementos de tabla de precios para una plantilla específica.
Obtener campos de documento

Obtiene una lista de campos de un documento o plantilla. Se puede usar tanto antes como después de que se haya firmado un documento.
Obtener campos de plantilla

Reciba una lista de campos para una plantilla específica.
Obtener datos adjuntos del documento

Obtiene los datos adjuntos del documento especificando un identificador de documento.
Obtener detalles del documento

Obtenga los detalles del documento especificando un identificador de documento.
Plantillas de lista

Reciba una lista de plantillas de documento disponibles. Puede agregar nuevas plantillas en la sección Plantillas de GetAccept.

Actualización de la expiración del documento

Id. de la operación:
UpdateExpiration

Use este método para actualizar la fecha y hora de expiración de un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento
Fecha de expiración
 expiration_date date-time

Fecha y hora en que el documento debe expirar (UTC)
Enviar notificación
 send_notification boolean

Si se debe enviar una notificación sobre la actualización a los destinatarios

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status integer

Estado de la actualización

Carga de un archivo de documento

Id. de la operación:
UploadDocument

Puede cargar un archivo cada vez y obtener un identificador de archivo. El identificador de archivo se usa para conectar un archivo con un documento GetAccept que se envía a los destinatarios. Si desea cargar archivos de mutliple, ejecute varias post. Solo aceptamos archivos de hasta 10 MB como valor predeterminado. El archivo cargado debe importarse o agregarse a un documento en un plazo de 48 horas después de la carga.

Se recomienda cargar archivos PDF con el fin de garantizar el mismo aspecto cuando se envía. Otros tipos de archivo se pueden convertir, como:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv

Parámetros

Nombre Clave Requerido Tipo Description
Contenido del archivo
 file_content string

Envíe el archivo como codificado en base64. Tenga en cuenta que los archivos de codificación base64 aumentarán el tamaño del archivo con aproximadamente 30%
Nombre del archivo
 file_name string

Nombre de archivo del documento, con la extensión . Esto será útil para convertir diferentes tipos de archivo.
Dirección URL del archivo
 file_url string

Dirección URL al archivo de documento. El archivo debe estar disponible para su descarga sin ninguna autorización

Devoluciones

Nombre Ruta de acceso Tipo Description
ID del archivo
 file_id string

Identificador del archivo cargado que se va a usar en file_ids al crear un documento
file_status
 file_status string

Estado del archivo cargado

Cargar datos adjuntos

Id. de la operación:
UploadAttachment

Puede cargar archivos adjuntos para incluirlos con documentos que envíe. La solicitud correcta devolverá el attachment_id. Use attachment_id para asignar datos adjuntos a un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Contenido del archivo
 file_content string

Envíe el archivo como codificado en base64. Tenga en cuenta que los archivos de codificación base64 aumentarán el tamaño del archivo con aproximadamente 30%
Nombre del archivo
 file_name string

Nombre de archivo del documento, con la extensión . Esto será útil para convertir diferentes tipos de archivo.
Dirección URL del archivo
 file_url string

Dirección URL al archivo de documento. El archivo debe estar disponible para su descarga sin ninguna autorización

Devoluciones

Nombre Ruta de acceso Tipo Description
Nombre del archivo
 filename string

Nombre de archivo de los datos adjuntos
Id. de datos adjuntos
 id string

Identificador de los datos adjuntos cargados que se van a usar en attachment_id al crear un documento
Título de datos adjuntos
 title string

Título de los datos adjuntos
Tipo de datos adjuntos
 type string

Tipo de datos adjuntos

Cargar un vídeo

Id. de la operación:
UploadVideo

Puede cargar archivos adjuntos para incluirlos con documentos que envíe. La solicitud correcta devolverá el attachment_id. Use attachment_id para asignar datos adjuntos a un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Contenido del archivo
 file_content string

Envíe el archivo como codificado en base64. Tenga en cuenta que los archivos de codificación base64 aumentarán el tamaño del archivo con aproximadamente 30%
Nombre del archivo
 file_name string

Nombre de archivo del documento, con la extensión . Esto será útil para convertir diferentes tipos de archivo.
Dirección URL del archivo
 file_url string

Dirección URL al archivo de documento. El archivo debe estar disponible para su descarga sin ninguna autorización

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado del archivo
 file_status string

Estado del vídeo
Nombre del archivo
 filename string

Nombre de archivo del vídeo
Id. del trabajo
 job_id string

Identificador del trabajo de procesamiento que convierte y comprime el vídeo. Sondee las actualizaciones de estado del trabajo mediante /video/job/<ID>.
Id. de vídeo
 video_id string

Identificador del vídeo cargado que se va a usar en video_id al crear un documento

Creación de un usuario

Id. de la operación:
CreateUser

Esto creará un nuevo contacto en la base de datos para la entidad actual.

Parámetros

Nombre Clave Requerido Tipo Description
company_name
 company_name string

Nombre de la compañía asociado
company_number
 company_number string

Número de empresa asociado
Correo electrónico
 email string

Dirección de correo electrónico del contacto
first_name
 first_name string

Nombre del contacto
fullname
 fullname string

Use para especificar el nombre completo en lugar de nombre o apellido
last_name
 last_name string

Apellidos del contacto
mobile
 mobile string

Número de móvil en formato internacional
nota
 note string

Nota interna opcional para el contacto
phone
 phone string

Número de teléfono en formato internacional
title
 title string

Título del contacto, p. ej. DIRECTOR GENERAL, Gerente de ventas

Devoluciones

Una dirección de correo electrónico define un usuario y está conectado a una o varias entidades.

Roles de usuario

Administrador:

  • Ver todos los documentos
  • Editar todos los documentos
  • Cambiar la configuración de entidad, la información y la facturación
  • Adición de nuevos usuarios a la entidad
  • Asignación de roles de entidad

Director:

  • Visualización de documentos de equipo
  • Editar todos los documentos
  • Adición de nuevos usuarios a la entidad

Entidad

Una entidad es el nodo superior y todos los usuarios y los documentos correspondientes están conectados a una entidad. Una entidad suele ser la misma que una empresa, un país o un departamento de una organización grande.

Usuario
User

Creación y envío de documentos o plantillas

Id. de la operación:
CreateDocument

Debe crear un documento para poder enviarlo a un destinatario. Al crear un documento, puede hacer referencia a archivos cargados previamente con file_id o puede optar por crear un documento y cargar los archivos en la publicación de API. Solo puede cargar un archivo ONE al incluir un archivo en el documento de creación POST.

Use file_ids parámetro para usar archivos cargados existentes file_content para enviar el documento como cadena codificada en base64 o realizar una publicación de varias partes con el parámetro file.

Todos los destinatarios deben tener un correo electrónico válido o un número de móvil.

Todos los eventos se registran mediante la dirección IP del solicitante. Puede invalidar esto mediante el encabezado CLIENT_IP que contiene la dirección IP pública de los usuarios finales.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
 id string

Id. de datos adjuntos recibidos de la lista o después de la carga
Requerir vista
 require_view boolean

Requerir que el destinatario vea los datos adjuntos
Tipo
 type string

archivo o externo donde el archivo es un archivo cargado y externo es un vínculo a un archivo externo
Id. de campo
 id string

Identificador del campo de plantilla personalizada
Nombre del campo
 name string

Nombre del campo de plantilla personalizada
Valor de campo
 value string

Valor del campo de plantilla personalizada
Moneda
 currency string

Moneda, por ejemplo, SEK
Configuración regional
 locale string

Configuración regional, por ejemplo, sv-SE
Nombre de pantalla
 display_name string

Nombre para mostrar de la tabla de precios
External ID
 external_id string

Identificador externo para representar el objeto de resumen dentro de un sistema de terceros
ID de tabla
 id string

ID de tabla
Totales calculados previamente
 pre_calculated boolean

Si los totales de la tabla de precios deben calcularse previamente
Nombre de pantalla
 display_name string

Nombre para mostrar de la tabla de precios
identificación
 id string

Id. de sección
Rows
 rows

Matriz con valores con matriz de column_id, valor
Enabled
 enabled boolean

Si se debe habilitar el descuento de sección
Tarifa plana
 flat_fee boolean

Si la sección debe usar con descuentos de tarifa plana
Valor de descuento
 value string

El valor del descuento de sección
Enabled
 enabled boolean

Si se debe habilitar el precio de sección
Tarifa plana
 flat_fee boolean

Si la sección debe usar el uso de precios de tarifas planas
Valor de precio
 value string

Valor de precio de sección
Enabled
 enabled boolean

Si se debe habilitar el impuesto de sección
Tarifa plana
 flat_fee boolean

Si la sección debe usar el uso de impuestos de tarifa plana
Valor fiscal
 value string

El valor de los impuestos de sección
Enabled
 enabled boolean

Si se debe habilitar el descuento de la tabla de precios
Tarifa plana
 flat_fee boolean

Si la tabla de precios debe usar el uso de descuentos de tarifas planas
Valor de descuento
 value string

Valor del descuento de resumen
Enabled
 enabled boolean

Si se debe habilitar el precio de la tabla de precios
Tarifa plana
 flat_fee boolean

Si la tabla de precios debe usar el uso de precios planos
Valor de precio
 value string

Valor del precio de resumen
Enabled
 enabled boolean

Si se debe habilitar el impuesto sobre la tabla de precios
Tarifa plana
 flat_fee boolean

Si la tabla de precios debe usar el uso de impuestos de tarifa plana
Importancia
 value string

El valor del impuesto de resumen
Fecha de expiración
 expiration_date date-time

Fecha y hora en que el documento debe expirar
External ID
 external_id string

Identificador del sistema externo para la identificación
Contenido del archivo
 file_content string

Contenido del archivo codificado en Base64
Identificadores de archivo
 file_ids string

Identificadores de archivo únicos separados por comas recibidos al cargar archivos
Nombre del archivo
 file_name string

Nombre de archivo del documento, con la extensión . Esto será útil para convertir diferentes tipos de archivo.
Dirección URL del archivo
 file_url string

Dirección URL al archivo de documento. Los documentos deben estar disponibles para su descarga
Enviar automáticamente
 is_automatic_sending boolean

Si el documento se debe enviar después de la creación
Enviar recordatorios
 is_reminder_sending boolean

¿Se deben enviar recordatorios automáticos?
Programar el envío
 is_scheduled_sending boolean

Si el envío debe estar programado para el envío en el futuro
Firmar documento
 is_signing boolean

Si se debe enviar el documento para la firma
Firma manuscrita
 is_signing_biometric boolean

Usar firma manuscrita
Permitir transferencia de firmas
 is_signing_forward boolean

Si los destinatarios pueden transferir derechos de firma
Firmar con iniciales
 is_signing_initials boolean

Firmar documento mediante iniciales de destinatario
Envío de SMS
 is_sms_sending boolean

Si el documento se envía al destinatario móvil por texto
Nombre del documento
 name True string

Escriba un nombre del documento.
Nombre de la compañía
 company_name string

Nombre de la compañía del destinatario
Número de empresa
 company_number string

Número de empresa del destinatario
Correo Electrónico
 email string

Dirección de correo electrónico del destinatario
Nombre
 first_name string

Nombre del destinatario
Apellido
 last_name string

Apellidos del destinatario
Móvil
 mobile string

Teléfono móvil en formato internacional
Nota:
 note string

Nota adicional para un destinatario
Orden de firma
 order_num integer

Si el orden de firma está habilitado
Tipo de destinatario
 role string

El tipo de destinatario del documento
Rol de plantilla
 role_name string

Nombre del rol en una plantilla
Comprobación de EID
 verify_eid boolean

Comprobación del uso de EID
Tipo de EID
 verify_eid_type string

Tipo de EID que se va a usar para la verificación personal
Habilitar pregunta
 verify_qna boolean

Si se debe hacer una pregunta
Respuesta de verificación
 verify_qna_answer string

La respuesta a la pregunta
Pregunta abierta
 verify_qna_open boolean

Debe preguntarse antes de abrir el documento.
Pregunta de verificación
 verify_qna_question string

Pregunta para solicitar comprobación
Pregunta de firma
 verify_qna_sign boolean

Si se debe hacer una pregunta antes de firmar
Comprobar SMS
 verify_sms boolean

Comprobación del destinatario por SMS
Comprobación de SMS al abrir
 verify_sms_open boolean

Comprobación de SMS al abrir
Comprobación por SMS
 verify_sms_sign boolean

Si un SMS comprueba el destinatario antes de firmar
Fecha de envío de programación
 scheduled_sending_time date-time

Fecha y hora en que se debe enviar el documento
Invalidación del correo electrónico del remitente
 sender_email string

Enviar desde otro correo electrónico que no sea usuario autenticado
Invalidación del usuario remitente
 sender_id string

Envío desde otro usuario distinto de autenticado
Identificador de plantilla
 template_id string

Selección de una plantilla que se va a usar para el envío
Tipo de documento
 type string

Establecimiento del tipo o categoría del documento
Valor del documento
 value integer

Valor de la oferta o documento
Id. de vídeo
 video_id string

Selección de un vídeo que se va a usar para el envío

Devoluciones

Un documento es uno o varios archivos cargados que se van a enviar a uno o varios destinatarios creados por un usuario.

Documento
Document

Crear contacto

Id. de la operación:
CreateContact

Esto creará un nuevo contacto en la base de datos para la entidad actual.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de la compañía
 company_name string

Nombre de la compañía asociado
Número de empresa
 company_number string

Número de empresa asociado
Correo Electrónico
 email string

Dirección de correo electrónico del contacto
Nombre
 first_name string

Nombre del contacto
Nombre completo
 fullname string

Use para especificar el nombre completo en lugar de nombre o apellido
Apellido
 last_name string

Apellidos del contacto
Móvil
 mobile string

Número de móvil en formato internacional
Nota:
 note string

Nota interna opcional para el contacto
Teléfono
 phone string

Número de teléfono en formato internacional
Title
 title string

Título del contacto, p. ej. DIRECTOR GENERAL, Gerente de ventas

Devoluciones

Nombre Ruta de acceso Tipo Description
ID de contacto
 contact_id string

Identificador del contacto creado

Descargar documento

Id. de la operación:
DownloadDocument

El archivo de documento siempre se puede descargar, pero lo más probable es que quiera descargarlo cuando tenga el estado Firmado.

Puede seleccionar recibir una dirección URL de descarga o obtener el archivo binario.

La dirección URL de descarga se puede acceder a 10 minutos después de realizar una solicitud.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento
Devolver el archivo binario directamente
 direct string

Devolver el archivo binario directamente

Devoluciones

Nombre Ruta de acceso Tipo Description
document_url
 document_url string
archivo
 file string

Enumerar contactos

Id. de la operación:
ListContacts

Reciba una lista de contactos disponibles para la entidad actual. Todos los contactos agregados como destinatarios se guardan como un contacto y están disponibles para su uso posterior en esa entidad.

Devoluciones

Lista de contactos

Contactos
Contacts

Enumerar datos adjuntos

Id. de la operación:
ListAttachments

Reciba una lista de datos adjuntos disponibles. Puede agregar nuevos datos adjuntos en GetAccept mediante un nuevo documento.

Devoluciones

Lista de datos adjuntos

Attachments
Attachments

Enumerar documentos

Id. de la operación:
ListDocuments

Obtener una lista de documentos disponibles

Parámetros

Nombre Clave Requerido Tipo Description
Lista de filtros sobre el estado
 filter string

Lista de filtros sobre el estado
Cómo ordenar los resultados
 sort_by string

Cómo ordenar los resultados
Criterio de ordenación de los resultados
 sort_order string

Criterio de ordenación de los resultados
Incluir documentos de miembros del equipo
 showteam boolean

Incluir documentos de miembros del equipo
Incluir todos los documentos de la entidad
 showall boolean

Incluir todos los documentos de la entidad
External ID
 external_id string

Un identificador externo es un campo personalizado que puede contener un identificador de registro único de un sistema fuera de GetAccept.
Desplazar
 offset number

Lista de inicio del registro x hasta el límite
Limit
 limit number

Número de registros que se van a enumerar

Devoluciones

Lista de documentos

Productos
Documents

Enumerar usuarios

Id. de la operación:
ListUsers

Captura de una lista de usuarios activos para la entidad autenticada actual

Devoluciones

Lista de usuarios

Users
Users

Enumerar vídeos

Id. de la operación:
ListVideos

Reciba una lista de vídeos disponibles en la entidad. Puede agregar nuevos vídeos en la aplicación móvil o dentro de GetAccept.

Devoluciones

Nombre Ruta de acceso Tipo Description
videos
 videos array of object
editable
 videos.editable boolean
publicado
 videos.published boolean
guardado
 videos.saved boolean
thumb_url
 videos.thumb_url string
video_id
 videos.video_id string
video_title
 videos.video_title string
video_type
 videos.video_type string
video_url
 videos.video_url string

Envío de un documento existente

Id. de la operación:
SendDocument

Al enviar un documento a través de GetAccept, entregamos un correo electrónico a todos los destinatarios, cada uno que contiene un vínculo único y protegido. Esta llamada API desencadena la acción de envío del documento y solo se puede realizar en documentos con document_status = borrador. El documento se enviará a los destinatarios que proporcionó cuando se creó.

Si el documento se creó con la opción autofirmado, también será autofirmado por el usuario autenticado o especificado antes de enviarlo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento
sender_email
 sender_email email

Úselo para especificar el usuario o propietario del remitente por dirección de correo electrónico que se usará para autofirmar el documento.
sender_id
 sender_id string

Úselo para especificar el usuario o propietario del remitente por identificador que se usará para autofirmar el documento.

Devoluciones

Un documento es uno o varios archivos cargados que se van a enviar a uno o varios destinatarios creados por un usuario.

Documento
Document

Obtención de destinatarios de documentos

Id. de la operación:
ListRecipients

Obtener una lista de destinatarios para un documento específico.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento

Devoluciones

Lista de destinatarios

Recipientes
Recipients

Obtención de detalles del usuario

Id. de la operación:
GetUserDetails

Esta llamada devolverá los detalles de un solo usuario. Recibir detalles y entidades disponibles del usuario autenticado actual mediante user-id me

Parámetros

Nombre Clave Requerido Tipo Description
Id. de usuario
 userId True string

Id. de usuario

Devoluciones

Una dirección de correo electrónico define un usuario y está conectado a una o varias entidades.

Roles de usuario

Administrador:

  • Ver todos los documentos
  • Editar todos los documentos
  • Cambiar la configuración de entidad, la información y la facturación
  • Adición de nuevos usuarios a la entidad
  • Asignación de roles de entidad

Director:

  • Visualización de documentos de equipo
  • Editar todos los documentos
  • Adición de nuevos usuarios a la entidad

Entidad

Una entidad es el nodo superior y todos los usuarios y los documentos correspondientes están conectados a una entidad. Una entidad suele ser la misma que una empresa, un país o un departamento de una organización grande.

Usuario
User

Obtención de roles de plantilla

Id. de la operación:
ListRoles

Reciba una lista de roles para una plantilla específica.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de plantilla
 templateId True string

Identificador de plantilla

Devoluciones

Nombre Ruta de acceso Tipo Description
roles
 roles array of object
Correo electrónico
 roles.email string
first_name
 roles.first_name string
last_name
 roles.last_name string
mobile
 roles.mobile string
role
 roles.role string
role_id
 roles.role_id string
role_name
 roles.role_name string

Obtención de tablas de precios de plantillas

Id. de la operación:
GetPricingTables

Reciba una lista de elementos de tabla de precios para una plantilla específica.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de plantilla
 templateId True string

Identificador de plantilla

Devoluciones

Tablas de precios

Pricing
PricingTables

Obtener campos de documento

Id. de la operación:
ListDocumentFields

Obtiene una lista de campos de un documento o plantilla. Se puede usar tanto antes como después de que se haya firmado un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento

Devoluciones

Lista de campos

Fields
Fields

Obtener campos de plantilla

Id. de la operación:
ListFields

Reciba una lista de campos para una plantilla específica.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de plantilla
 templateId True string

Identificador de plantilla

Devoluciones

Lista de campos

Fields
Fields

Obtener datos adjuntos del documento

Id. de la operación:
GetDocumentAttachments

Obtiene los datos adjuntos del documento especificando un identificador de documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento

Devoluciones

Lista de datos adjuntos

Attachments
Attachments

Obtener detalles del documento

Id. de la operación:
GetDocumentDetails

Obtenga los detalles del documento especificando un identificador de documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 documentId True string

Id. de documento

Devoluciones

Un documento es uno o varios archivos cargados que se van a enviar a uno o varios destinatarios creados por un usuario.

Documento
Document

Plantillas de lista

Id. de la operación:
ListTemplates

Reciba una lista de plantillas de documento disponibles. Puede agregar nuevas plantillas en la sección Plantillas de GetAccept.

Parámetros

Nombre Clave Requerido Tipo Description
Mostrar todo
 showall string

Mostrar todas las plantillas para la entidad
Id. de carpeta
 folder_id string

Mostrar plantillas en una carpeta específica

Devoluciones

Nombre Ruta de acceso Tipo Description
templates
 templates array of object
tags
 templates.tags string
fecha_de_creación
 templates.created_at string
external_editor_type
 templates.external_editor_type string
field_count
 templates.field_count integer
id
 templates.id string
is_editable
 templates.is_editable boolean
is_private
 templates.is_private boolean
nombre
 templates.name string
page_count
 templates.page_count integer
role_count
 templates.role_count integer
sender_name
 templates.sender_name string
sender_thumb_url
 templates.sender_thumb_url string
thumb_url
 templates.thumb_url string
type
 templates.type string
user_id
 templates.user_id string
video_id
 templates.video_id string
video_thumb_url
 templates.video_thumb_url string

Desencadenadores

Cuando se ha firmado un documento

Se desencadena cuando todas las partes de firma han firmado un documento
Cuando se ha rechazado un documento

Desencadena cuando cualquiera de los destinatarios rechaza un documento
Cuando se ha revisado un documento

Se desencadena cuando cualquiera de los destinatarios ha revisado un documento
Suscribirse a eventos de documento

Esta llamada creará una nueva suscripción. La respuesta se ajustará en una matriz incluso para un solo objeto según los estándares de enlace REST.

Eventos

  • document.created - Se crea el documento
  • document.sent - Se envía el documento
  • document.viewed - Se envía el documento
  • document.signed - El documento está firmado
  • document.approved - Se aprueba el documento
  • document.expired - El documento ha expirado
  • document.rejected - Se rechaza el documento
  • document.downloaded - Se descarga el documento
  • document.printed - Se imprime el documento
  • document.forwarded - Se reenvía el documento
  • document.partially_signed - El documento se ha firmado parcialmente
  • document.commented - Se comenta el documento
  • document.hardbounced - El documento está en disco duro
  • document.imported - El documento se importa

Cuando se ha firmado un documento

Id. de la operación:
CreateSignedSubscription

Se desencadena cuando todas las partes de firma han firmado un documento

Parámetros

Nombre Clave Requerido Tipo Description
Todos los usuarios de entidad
 global boolean

Si el webhook debe detectar eventos para todos los usuarios de entidades.
Correo electrónico de error
 notification_email string

Si se produce un error en el evento, envíe una notificación a este correo electrónico en lugar del remitente.
Carga
 payload string

Datos de carga adicionales para publicar

Devoluciones

Carga útil de webhook

Webhook
Webhook

Cuando se ha rechazado un documento

Id. de la operación:
CreateRejectedSubscription

Desencadena cuando cualquiera de los destinatarios rechaza un documento

Parámetros

Nombre Clave Requerido Tipo Description
Todos los usuarios de entidad
 global boolean

Si el webhook debe detectar eventos para todos los usuarios de entidades.
Correo electrónico de error
 notification_email string

Si se produce un error en el evento, envíe una notificación a este correo electrónico en lugar del remitente.
Carga
 payload string

Datos de carga adicionales para publicar

Devoluciones

Carga útil de webhook

Webhook
Webhook

Cuando se ha revisado un documento

Id. de la operación:
CreateReviewedSubscription

Se desencadena cuando cualquiera de los destinatarios ha revisado un documento

Parámetros

Nombre Clave Requerido Tipo Description
Todos los usuarios de entidad
 global boolean

Si el webhook debe detectar eventos para todos los usuarios de entidades.
Correo electrónico de error
 notification_email string

Si se produce un error en el evento, envíe una notificación a este correo electrónico en lugar del remitente.
Carga
 payload string

Datos de carga adicionales para publicar

Devoluciones

Carga útil de webhook

Webhook
Webhook

Suscribirse a eventos de documento

Id. de la operación:
CreateSubscription

Esta llamada creará una nueva suscripción. La respuesta se ajustará en una matriz incluso para un solo objeto según los estándares de enlace REST.

Eventos

  • document.created - Se crea el documento
  • document.sent - Se envía el documento
  • document.viewed - Se envía el documento
  • document.signed - El documento está firmado
  • document.approved - Se aprueba el documento
  • document.expired - El documento ha expirado
  • document.rejected - Se rechaza el documento
  • document.downloaded - Se descarga el documento
  • document.printed - Se imprime el documento
  • document.forwarded - Se reenvía el documento
  • document.partially_signed - El documento se ha firmado parcialmente
  • document.commented - Se comenta el documento
  • document.hardbounced - El documento está en disco duro
  • document.imported - El documento se importa

Parámetros

Nombre Clave Requerido Tipo Description
Seleccionar evento
 event True string

Desencadenador de eventos
Todos los usuarios de entidad
 global boolean

Si el webhook debe detectar eventos para todos los usuarios de entidades.
Correo electrónico de error
 notification_email string

Si se produce un error en el evento, envíe una notificación a este correo electrónico en lugar del remitente.
Carga
 payload string

Datos de carga adicionales para publicar

Devoluciones

Carga útil de webhook

Webhook
Webhook

Definiciones

Datos adjuntos

Datos adjuntos del documento

Nombre Ruta de acceso Tipo Description
Destinatarios de acceso
 access_recipient_names array of string

Destinatarios con acceso a los datos adjuntos
Description
 attachment_description string

Descripción de los datos adjuntos
Dirección URL de descarga
 attachment_download_url string

Dirección URL para descargar los datos adjuntos
Extensión de archivo
 attachment_extension string

Extensión de archivo de los datos adjuntos
Filename
 attachment_filename string

Nombre de archivo de los datos adjuntos
identificación
 attachment_id string

Identificador de los datos adjuntos
Dirección URL de vista previa
 attachment_preview_url string

Dirección URL interna para obtener una vista previa de los datos adjuntos
Title
 attachment_title string

Título de los datos adjuntos
Tipo
 attachment_type string

Tipo de datos adjuntos
URL
 attachment_url string

Dirección URL de los datos adjuntos
Última vista
 last_attachment_view string

Fecha y hora en que se vieron por última vez los datos adjuntos
Acceso restringido
 restrict_access boolean

Los datos adjuntos tienen acceso restringido

Attachments

Lista de datos adjuntos

Nombre Ruta de acceso Tipo Description
attachments
 attachments array of Attachment

Contacto

Cada dirección de correo electrónico única (o número de móvil) se define como un contacto.

Nombre Ruta de acceso Tipo Description
Id. de empresa
 company_id string

Id. de empresa
Logotipo de la empresa
 company_logo_url string

Logotipo de la empresa
Nombre de la compañía
 company_name string

Nombre de la empresa del contacto
Número de empresa
 company_number string

Número de empresa del contacto
ID de contacto
 contact_id string

ID de contacto
Creado
 created_at string

Fecha de contacto creada
Documentos
 document_count number

Número de documentos de un contacto
Correo electrónico de contacto
 email string

Nombre del documento creado
Nombre
 first_name string

Nombre del contacto
Nombre completo
 fullname string

Nombre completo del contacto
Gender
 gender string

Sexo del destinatario
Apellido
 last_name string

Apellidos del contacto
Móvil
 mobile string

Número móvil del contacto
Nota:
 note string

Nota del contacto
Dirección URL de pulgar
 thumb_url string

Dirección URL de pulgar del contacto
Title
 title string

Título del contacto

Contactos

Lista de contactos

Nombre Ruta de acceso Tipo Description
contacts
 contacts array of Contact

Documento

Un documento es uno o varios archivos cargados que se van a enviar a uno o varios destinatarios creados por un usuario.

Nombre Ruta de acceso Tipo Description
Etiquetas
 tags string

Etiquetas de documento
Texto automático del chat
 auto_comment_text string

Texto automático del chat
Nombre de la compañía
 company_name string

Nombre de la compañía
Creado en
 created_at string

Cuándo se creó el documento
Dirección URL de descarga
 download_url string

Dirección URL para descargar el documento firmado
Mensaje de correo electrónico
 email_send_message string

Envío de un mensaje de correo electrónico
Asunto del correo electrónico
 email_send_subject string

Texto del asunto del correo electrónico
Fecha de expiración
 expiration_date string

Fecha de expiración del documento
Id. de cliente externo
 external_client_id string
Id. del editor externo
 external_editor_id string

Identificador en el editor externo
Tipo de editor externo
 external_editor_type string
External ID
 external_id string
Recuento de campos
 field_count integer

Número de campos del documento
identificación
 id string
Comentario automático
 is_auto_comment boolean

Si el comentario automático de chat está habilitado
Correo electrónico de comentario automático
 is_auto_comment_email boolean

Si está habilitado el correo electrónico de chat automático
Identificación del destinatario
 is_identify_recipient boolean

Si el documento ha habilitado la identificación del destinatario
Es privado
 is_private boolean

Si el documento es privado
Enviar recordatorios
 is_reminder_sending boolean

Si los recordatorios automáticos están habilitados
Envío programado
 is_scheduled_sending boolean

Si el documento ha programado el envío
Firma automática
 is_selfsign boolean

Si el remitente ha firmado el documento automáticamente
Está firmado
 is_signed boolean

Si el documento se ha firmado
Documento que se puede firmar
 is_signing boolean

Si el documento se puede firmar
Firma manuscrita
 is_signing_biometric boolean

Si la firma manuscrita está habilitada
Permitir transferencia de firmas
 is_signing_forward boolean

Si la transferencia de derechos de firma está habilitada
Orden de firma
 is_signing_order boolean

Si el orden de firma del destinatario está habilitado
Tiene vídeo
 is_video boolean

Si el documento tiene un vídeo de introducción
Nombre
 name string

Nombre del documento
Id. primario
 parent_id string

Id. de la versión anterior del documento
Dirección URL de vista previa
 preview_url string

Vínculo a la versión preliminar interna del documento
destinatarios
 recipients array of Recipient
Hora de envío programada
 scheduled_sending_time string

Cuándo se programó el documento para enviar
Fecha de envío
 send_date string

Fecha de envío de documentos
Correo electrónico del remitente
 sender_email string

Dirección de correo electrónico del usuario remitente
Nombre del remitente
 sender_name string

Nombre del usuario remitente
Dirección URL de pulgar del remitente
 sender_thumb_url string

Imagen digital del usuario remitente
Fecha de inicio de sesión
 sign_date string

Fecha de firma del documento
Estado
 status string

Estado actual del documento
Dirección URL de pulgar
 thumb_url string

Imagen digital del documento
Tipo
 type string

Tipo de documento
Id. único
 unique_id integer

Identificador único del documento
Id. de usuario
 user_id string

Identificador del usuario remitente
Importancia
 value integer

Valor del documento

Documentos

Lista de documentos

Nombre Ruta de acceso Tipo Description
tags
 tags string
company_name
 company_name string
fecha_de_creación
 created_at string
expiration_date
 expiration_date string
id
 id string
is_private
 is_private boolean
is_signing
 is_signing boolean
nombre
 name string
sender_name
 sender_name string
sender_thumb
 sender_thumb string
estado
 status string
type
 type string
value
 value integer

EditorField

Detalles del campo del editor

Nombre Ruta de acceso Tipo Description
identificación
 id string

identificación
Etiqueta
 input_settings.label string

Etiqueta
Options
 input_settings.options array of string

Options
Obligatorio
 input_settings.required boolean

Obligatorio
Tipo
 input_settings.type string

Tipo
Id. de destinatario
 recipient_id string

Id. de destinatario
Tipo
 type string

Tipo
Id. de usuario
 user_id string

Id. de usuario

Campo

Detalles del campo

Nombre Ruta de acceso Tipo Description
Nombre de la compañía
 company_name string

Nombre de la compañía
Número de empresa
 company_number string

Número de empresa
Id. de campo
 field_id string

Id. de campo
Etiqueta
 field_label string

Etiqueta
Options
 field_options array of object

Options
Importancia
 field_options.value string
Tipo
 field_type string

Tipo
Importancia
 field_value string

Importancia
is_collectable
 is_collectable boolean

Recopilación de campos
is_editable
 is_editable boolean

Campo editable
is_required
 is_required boolean

Campo obligatorio
Id. de página
 page_id string

Id. de página
Id. de destinatario
 recipient_id string

Id. de destinatario
Nombre del destinatario
 recipient_name string

Nombre del destinatario
Nombre del rol
 role_name string

Nombre del rol

Fields

Lista de campos

Nombre Ruta de acceso Tipo Description
editor_fields
 editor_fields array of EditorField
fields
 fields array of Field

PricingColumn

Columna de tabla de precios

Nombre Ruta de acceso Tipo Description
identificación
 column_id string

identificación
Nombre de pantalla
 display_name string

Nombre de pantalla
Enabled
 enabled boolean

Enabled
Nombre
 name string

Nombre

PricingSection

Sección de tabla de precios

Nombre Ruta de acceso Tipo Description
columns
 columns array of PricingColumn
Nombre de pantalla
 display_name string

Nombre de pantalla
Nombre
 name string

Nombre
identificación
 section_id string

identificación

PricingTable

Tabla de precios

Nombre Ruta de acceso Tipo Description
Moneda
 currency_settings.currency string

Moneda
Configuración regional
 currency_settings.locale string

Configuración regional
Totales calculados previamente
 pre_calculated boolean

Totales calculados previamente
Secciones
 sections array of PricingSection
identificación
 table_id string

ID de tabla

PricingTables

Tablas de precios

Nombre Ruta de acceso Tipo Description
pricing_tables
 pricing_tables array of PricingTable

Destinatario

Cada dirección de correo electrónico única (o número de móvil) que está conectada a un documento es un destinatario.

Nombre Ruta de acceso Tipo Description
Nombre de la compañía
 company_name string

Nombre de la compañía del destinatario
Número de empresa
 company_number string

Número de empresa del destinatario
Dirección URL del documento
 document_url string

Dirección URL única para que el destinatario vea o firme
Correo electrónico del destinatario
 email string

Correo electrónico del destinatario
Nombre
 first_name string

Nombre del destinatario
Nombre completo
 fullname string

Nombre completo del destinatario
Gender
 gender string

Sexo del destinatario
identificación
 id string

Id. del destinatario
Apellido
 last_name string

Apellidos del destinatario
Móvil
 mobile string

Número de móvil del destinatario
Nota:
 note string

Nota del destinatario
Número de pedido de firma
 order_num string

Orden de firma del destinatario
Estado
 status string

Estado del destinatario
Dirección URL de pulgar
 thumb_url string

Dirección URL de pulgar del destinatario
Title
 title string

Título del destinatario

Recipientes

Lista de destinatarios

Nombre Ruta de acceso Tipo Description
destinatarios
 recipients array of Recipient

Usuario

Una dirección de correo electrónico define un usuario y está conectado a una o varias entidades.

Roles de usuario

Administrador:

  • Ver todos los documentos
  • Editar todos los documentos
  • Cambiar la configuración de entidad, la información y la facturación
  • Adición de nuevos usuarios a la entidad
  • Asignación de roles de entidad

Director:

  • Visualización de documentos de equipo
  • Editar todos los documentos
  • Adición de nuevos usuarios a la entidad

Entidad

Una entidad es el nodo superior y todos los usuarios y los documentos correspondientes están conectados a una entidad. Una entidad suele ser la misma que una empresa, un país o un departamento de una organización grande.

Nombre Ruta de acceso Tipo Description
Modo de aplicación
 app_mode string
disallow_create
 disallow_create boolean
Correo Electrónico
 email string

Dirección de correo electrónico del usuario
ID de entidad
 entity_id string
Nombre de entidad
 entity_name string
Nombre
 first_name string

Nombre del usuario
identificación
 id string

Identificador del usuario
Language
 language string
Apellido
 last_name string

Apellidos del usuario
mobile
 mobile string

Número de móvil en formato internacional
Nota:
 note string

Nota interna opcional para el usuario
Teléfono
 phone string

Número de teléfono en formato internacional
Rol
 role string
Omitir el envío de invitación
 skip_invitation boolean
Estado
 status string
Id. de equipo
 team_id string
Dirección URL de pulgar
 thumb_url string
Timezone
 timezone string
Title
 title string

Título del usuario, por ejemplo. DIRECTOR GENERAL, Gerente de ventas

Users

Lista de usuarios

Nombre Ruta de acceso Tipo Description
users
 users array of object
Correo Electrónico
 users.email string
Nombre
 users.first_name string
Último inicio de sesión
 users.last_login string
Apellido
 users.last_name string
Nombre de usuario
 users.name string
Rol
 users.role string
Estado
 users.status string
Nombre del equipo
 users.team_name string
Id. de usuario
 users.user_id string

Webhook

Carga útil de webhook

Nombre Ruta de acceso Tipo Description
Campos personalizados
 custom_fields object
Documento
 document Document

Un documento es uno o varios archivos cargados que se van a enviar a uno o varios destinatarios creados por un usuario.
Dominio personalizado de entidad
 entity.custom_domain string

Configuración de dominio personalizada para la entidad
Mensaje de correo electrónico predeterminado
 entity.email_send_message string

Mensaje de correo electrónico predeterminado
Asunto de correo electrónico predeterminado
 entity.email_send_subject string

Asunto de correo electrónico predeterminado
Subdominio de entidad
 entity.sub_domain string

Subdominio de la entidad
Nombre de evento
 event string
Acción de evento
 event_action string
Tipo de evento
 event_type string
Destinatario
 recipient Recipient

Cada dirección de correo electrónico única (o número de móvil) que está conectada a un documento es un destinatario.
Id. de suscripción
 subscription_id string