Annature (Publicador independiente) (versión preliminar)
Annature es la solución de eSigning de propiedad australiana líder con un proveedor de firmas digitales integrado. Este conector ayuda a las empresas a crear sobres e integrar el flujo de trabajo de firma de documentos annature mediante Annature API (v1).
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 | Dr. Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| Correo Electrónico | adrian@strategik.com.au |
| Metadatos del conector | |
|---|---|
| Publicador | Dr. Adrian Colquhoun (Strategik) |
| Sitio web | https://annature.com.au |
| Directiva de privacidad | https://www.annature.com.au/privacy-policy |
| Categorías | Productividad |
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 |
|---|---|---|---|
| Annature Id | cuerda / cadena | Annature Id | Cierto |
| Clave annature | securestring | Clave annature | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Crear sobre |
Crear sobre |
| Crear sobre a partir de una plantilla |
Usar plantilla |
| Eliminar sobre |
Eliminar sobre |
| Enviar sobre |
Enviar sobre |
| Obtener campo |
Obtener campo |
| Obtener campos |
Enumerar todos los campos |
| Obtener cuentas |
Enumerar todas las cuentas |
| Obtener destinatario |
Obtener un único destinatario creado para un sobre mediante la propiedad id que se devolvió en el cuerpo de la respuesta de creación de un sobre |
| Obtener documentos |
Enumerar todos los documentos de un sobre |
| Obtener organización |
Obtener organización |
| Obtener plantilla |
Obtener plantilla |
| Obtener plantillas |
Enumerar todas las plantillas |
| Obtener sobre |
Obtener sobre |
| Obtener sobres |
Enumerar todos los sobres |
| Obtener todos los datos adjuntos de un campo |
Obtener datos adjuntos de campo |
| Sobre void |
Enviar sobre |
Crear sobre
Crear sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
name | True | string |
El nombre del sobre, que se muestra en el asunto de los correos electrónicos enviados a los destinatarios y al ver el sobre |
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Está en borrador
|
draft | boolean |
Está en borrador |
|
|
Id. de cuenta
|
account_id | True | string |
Id. de cuenta |
|
Id. de grupo
|
group_id | string |
Id. de grupo |
|
|
Id. de grupo
|
id | string |
Id. de grupo |
|
|
Nombre
|
name | string |
Nombre |
|
|
Tipo
|
type | string |
Tipo |
|
|
Contenido del archivo
|
base | byte |
Contenido del archivo |
|
|
Nombre
|
name | string |
Nombre |
|
|
Id. de correo electrónico
|
string |
Id. de correo electrónico |
||
|
Móvil
|
mobile | string |
Móvil |
|
|
Tipo de destinatario
|
type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
|
Message
|
message | string |
Message |
|
|
contraseña
|
password | string | ||
|
¿Silenciado?
|
muted | boolean |
Esto impedirá que Annature envíe cualquier correspondencia al destinatario |
|
|
Orden de firma
|
order | integer |
Orden de firma |
|
|
Sesión completada
|
session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
|
Sesión rechazada
|
session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
|
|
id
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
type
|
type | string |
Tipo de campo |
|
|
página
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
Obligatorio
|
required | boolean |
Obligatorio |
|
|
Solo para lectura
|
read_only | boolean |
Solo para lectura |
|
|
Colaborativo
|
collaborative | boolean |
Colaborativo |
|
|
Ancho
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
Los valores posibles son courier y helvetica |
|
|
creado
|
created | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
Mensaje
|
message | string |
Message |
|
estado
|
status | string |
Estado |
|
Shared
|
shared | boolean |
Shared |
|
Creadas el
|
created | string |
Creadas el |
|
Enviado al
|
sent | string |
Enviado al |
|
Anulada
|
voided | ||
|
Disminuido
|
declined | ||
|
completado
|
completed | ||
|
ID de cuenta
|
account_id | string |
Account_id |
|
Id. de grupo
|
group_id | string |
Id. de grupo |
|
destinatarios
|
recipients | array of object | |
|
id
|
recipients.id | string | |
|
nombre
|
recipients.name | string | |
|
Correo electrónico
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
type
|
recipients.type | string | |
|
estado
|
recipients.status | string | |
|
Mensaje
|
recipients.message | string | |
|
Contraseña
|
recipients.password |
Contraseña |
|
|
Silenciado
|
recipients.muted | boolean |
Silenciado |
|
order
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
creado
|
recipients.created | string | |
|
enviado
|
recipients.sent | string | |
|
Disminuido
|
recipients.declined | ||
|
completado
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Crear sobre a partir de una plantilla
Usar plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de plantilla
|
id | True | string |
Identificador de plantilla |
|
Nombre
|
name | string |
El nombre del sobre, que se muestra en el asunto de los correos electrónicos enviados a los destinatarios y al ver el sobre |
|
|
Está en borrador
|
draft | boolean |
Está en borrador |
|
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Id. de cuenta
|
account_id | True | string |
Id. de cuenta |
|
Id. de grupo
|
group_id | string |
Id. de grupo |
|
|
Id. de grupo
|
id | string |
Id. de grupo |
|
|
Nombre
|
name | string |
Nombre |
|
|
Id. de grupo
|
type | string |
Id. de grupo |
|
|
Contenido del archivo
|
base | byte |
Contenido del archivo |
|
|
Id. de rol
|
role_id | string |
Id. de rol |
|
|
Nombre
|
name | string |
Nombre |
|
|
Id. de correo electrónico
|
string |
Id. de correo electrónico |
||
|
Móvil
|
mobile | string |
Móvil |
|
|
Autenticación de SMS
|
sms_auth | string |
Autenticación de SMS |
|
|
Tipo de destinatario
|
type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
|
Message
|
message | string |
Message |
|
|
contraseña
|
password | string | ||
|
¿Silenciado?
|
muted | boolean |
Esto impedirá que Annature envíe cualquier correspondencia al destinatario |
|
|
Orden de firma
|
order | integer |
Orden de firma |
|
|
Id. de campo (de plantilla)
|
id | True | string |
Identificador del campo de plantilla |
|
Importancia
|
value | True | string |
Valor de este campo |
|
Punto de conexión de destino después de que el destinatario haya completado el sobre
|
session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
|
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre
|
session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
Mensaje
|
message | string |
Message |
|
compartido
|
shared | boolean |
¿Es compartido? |
|
draft
|
draft | boolean | |
|
account_id
|
account_id | string |
ID de cuenta |
|
group_id
|
group_id | string |
Id. de grupo |
|
Documentos
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nombre
|
documents.name | string |
Nombre |
|
pages
|
documents.pages | integer | |
|
Texto original
|
documents.original | string |
Texto original |
|
Maestro
|
documents.master | string |
Maestro |
|
Creado
|
documents.created | string |
Creado |
|
destinatarios
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
nombre
|
recipients.name | string | |
|
Correo electrónico
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
Mensaje
|
recipients.message | string | |
|
contraseña
|
recipients.password | boolean | |
|
Silenciado
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Eliminar sobre
Eliminar sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
id | True | string |
Id. de sobre |
Enviar sobre
Enviar sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
id | True | string |
Id. de sobre |
Obtener campo
Obtener campo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
envelope_id | True | string |
Id. de sobre |
|
Id. de campo
|
id | True | string |
Id. de campo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
recipient_id
|
recipient_id | string |
Id. de destinatario |
|
type
|
type | string |
Tipo |
|
página
|
page | integer | |
|
delimitador
|
anchor | string |
Anchor |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obligatorio
|
required | boolean |
Obligatorio |
|
Read_only
|
read_only | boolean |
Read_only |
|
Colaborativo
|
collaborative | boolean |
Permite que otros destinatarios del sobre modifiquen los valores |
|
value
|
value | string |
Valor del campo |
|
Comprobado
|
checked | boolean |
Comprobado |
|
altura
|
height | integer | |
|
Ancho
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
Los valores posibles son courier y helvetica |
|
date_format
|
date_format | string |
Formato de fecha |
|
creado
|
created | string |
Creado |
Obtener campos
Enumerar todos los campos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
envelope_id | True | string |
Id. de sobre |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
type
|
type | string | |
|
página
|
page | integer | |
|
delimitador
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obligatorio
|
required | boolean |
Obligatorio |
|
Read_only
|
read_only | boolean |
Read_only |
|
Colaborativo
|
collaborative | boolean |
Colaborativo |
|
value
|
value | string | |
|
Comprobado
|
checked | boolean |
Comprobado |
|
altura
|
height | integer | |
|
Ancho
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
creado
|
created | string |
Obtener cuentas
Enumerar todas las cuentas
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Nombre
|
name | string |
Nombre |
|
Correo Electrónico
|
string |
Correo Electrónico |
|
|
number
|
number | string | |
|
timezone
|
timezone | string | |
|
role
|
role | string | |
|
activo
|
active | boolean | |
|
group_id
|
group_id | string | |
|
creado
|
created | string | |
|
verificado
|
verified | string |
Obtener destinatario
Obtener un único destinatario creado para un sobre mediante la propiedad id que se devolvió en el cuerpo de la respuesta de creación de un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Destinatario
|
id | True | string |
Id. de destinatario |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
Correo electrónico
|
string |
Correo Electrónico |
|
|
mobile
|
mobile | string |
Móvil |
|
type
|
type | string |
Tipo |
|
estado
|
status | string |
Estado |
|
Mensaje
|
message | string |
Message |
|
Contraseña
|
password |
Contraseña |
|
|
Silenciado
|
muted | boolean |
Silenciado |
|
order
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
creado
|
created | string |
Creado |
|
enviado
|
sent | string |
Sent |
|
Disminuido
|
declined | string |
Rechazado |
|
completado
|
completed | string |
Completado |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
Obtener documentos
Enumerar todos los documentos de un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
envelope_id | True | string |
Id. de sobre |
|
Duración del punto de conexión
|
endpoint_duration | integer |
Establece el número de minutos para los que serán accesibles los puntos de conexión originales y maestros. El número puede oscilar entre 1 y 10080 y el valor predeterminado es 60. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
Id |
|
Nombre
|
name | string |
Nombre |
|
pages
|
pages | integer | |
|
Texto original
|
original | string |
Texto original |
|
Maestro
|
master | string |
Maestro |
|
Creado
|
created | string |
Creado |
Obtener organización
Obtener organización
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
negocio
|
business | string |
Negocio |
|
Correo electrónico
|
string |
Correo Electrónico |
|
|
number
|
number | string |
Number |
|
address
|
address | string |
Dirección |
|
sitio web
|
website | string |
Sitio web |
|
logo
|
logo | string |
Logotipo |
|
color
|
colour | string |
Color |
|
creado
|
created | string |
Creado |
Obtener plantilla
Obtener plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de plantilla
|
id | True | string |
Identificador de plantilla |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
creado
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentos
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nombre
|
documents.name | string |
Nombre |
|
pages
|
documents.pages | integer | |
|
Texto original
|
documents.original | string |
Texto original |
|
Maestro
|
documents.master | string |
Maestro |
|
Creado
|
documents.created | string |
Creado |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nombre
|
roles.name | string |
Nombre |
|
Nombre del destinatario
|
roles.recipient_name | string |
Nombre del destinatario |
|
Correo electrónico del destinatario
|
roles.recipient_email | string |
Correo electrónico del destinatario |
|
Destinatario móvil
|
roles.recipient_mobile | string |
Destinatario móvil |
|
Tipo de destinatario
|
roles.recipient_type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
Contraseña
|
roles.recipient_password | string |
Contraseña |
|
Orden de firma
|
roles.order | integer |
Orden de firma |
|
Punto de conexión de destino después de que el destinatario haya completado el sobre
|
roles.recipient_redirects.session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre
|
roles.recipient_redirects.session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
Obtener plantillas
Enumerar todas las plantillas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
name | string |
Filtro de coincidencia exacta en la lista basado en las plantillas |
|
|
Creado antes
|
created_before | date |
Devuelve los resultados en los que la fecha de creación es anterior al valor especificado. |
|
|
Creado después
|
created_after | date |
Devuelve los resultados en los que la fecha de creación es posterior al valor especificado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
nombre
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
creado
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentos
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nombre
|
documents.name | string |
Nombre |
|
pages
|
documents.pages | integer | |
|
Texto original
|
documents.original | string |
Texto original |
|
Maestro
|
documents.master | string |
Maestro |
|
Creado
|
documents.created | string |
Creado |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nombre
|
roles.name | string |
Nombre |
|
Nombre del destinatario
|
roles.recipient_name | string |
Nombre del destinatario |
|
Correo electrónico del destinatario
|
roles.recipient_email | string |
Correo electrónico del destinatario |
|
Destinatario móvil
|
roles.recipient_mobile | string |
Destinatario móvil |
|
Tipo de destinatario
|
roles.recipient_type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
Contraseña
|
roles.recipient_password | string |
Contraseña |
|
Orden de firma
|
roles.order | integer |
Orden de firma |
|
Punto de conexión de destino después de que el destinatario haya completado el sobre
|
roles.recipient_redirects.session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre
|
roles.recipient_redirects.session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
Obtener sobre
Obtener sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
id | True | string |
Id. de sobre |
|
Duración del punto de conexión
|
endpoint_duration | integer |
Establece el número de minutos para los que serán accesibles los puntos de conexión originales y maestros. El número puede oscilar entre 1 y 10080 y el valor predeterminado es 60. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
Mensaje
|
message | string |
Message |
|
estado
|
status | string |
Estado |
|
compartido
|
shared | boolean |
Shared |
|
creado
|
created | string |
Creado |
|
enviado
|
sent | string |
Sent |
|
Anulada
|
voided | string |
Anulado |
|
Disminuido
|
declined | string |
Rechazado |
|
completado
|
completed | string |
Completado |
|
master
|
master | string |
Maestro |
|
combinado
|
combined | string |
Combinado |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID de cuenta |
|
group_id
|
group_id | string |
Id. de grupo |
|
Recipientes
|
recipients | array of object | |
|
Nombre
|
recipients.name | string |
Nombre |
|
Id. de correo electrónico
|
recipients.email | string |
Id. de correo electrónico |
|
Móvil
|
recipients.mobile | string |
Móvil |
|
Tipo de destinatario
|
recipients.type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
Message
|
recipients.message | string |
Message |
|
Contraseña
|
recipients.password | ||
|
¿Silenciado?
|
recipients.muted | boolean |
Esto impedirá que Annature envíe cualquier correspondencia al destinatario |
|
Orden de firma
|
recipients.order | integer |
Orden de firma |
|
Punto de conexión de destino después de que el destinatario haya completado el sobre
|
recipients.redirects.session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre
|
recipients.redirects.session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
|
fields
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
página
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obligatorio
|
recipients.fields.required | boolean |
Obligatorio |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Colaborativo
|
recipients.fields.collaborative | boolean |
Colaborativo |
|
Ancho
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
creado
|
recipients.fields.created | string |
Obtener sobres
Enumerar todos los sobres
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del sobre
|
name | string |
Filtro de coincidencia exacta en la lista basado en la propiedad name del sobre |
|
|
Estado del sobre
|
status | string |
Filtro de coincidencia exacta en la lista según el estado del sobre |
|
|
Nombre del destinatario
|
recipient | string |
Filtro de coincidencia exacta en la lista en función del nombre o la propiedad de correo electrónico de cualquier destinatario |
|
|
Creado antes
|
created_before | date |
Devuelve los resultados en los que la fecha de creación es anterior al valor especificado. |
|
|
Creado después
|
created_after | date |
Devuelve los resultados en los que la fecha de creación es posterior al valor especificado. |
|
|
Completado antes
|
completed_before | date |
Devuelve los resultados en los que la fecha de finalización es anterior al valor especificado. |
|
|
Completado después de
|
completed_after | date |
Devuelve los resultados en los que la fecha de finalización es posterior al valor especificado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Id |
|
nombre
|
name | string |
Nombre |
|
Mensaje
|
message | string |
Message |
|
estado
|
status | string |
Estado |
|
compartido
|
shared | boolean |
Shared |
|
creado
|
created | string |
Creado |
|
enviado
|
sent | string |
Sent |
|
Anulada
|
voided | string |
Anulado |
|
Disminuido
|
declined | string |
Rechazado |
|
completado
|
completed | string |
Completado |
|
combinado
|
combined | string |
Combinado |
|
master
|
master | string |
Maestro |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID de cuenta |
|
group_id
|
group_id | string |
Id. de grupo |
|
Recipientes
|
recipients | array of object | |
|
Nombre
|
recipients.name | string |
Nombre |
|
Id. de correo electrónico
|
recipients.email | string |
Id. de correo electrónico |
|
Móvil
|
recipients.mobile | string |
Móvil |
|
Tipo de destinatario
|
recipients.type | string |
El tipo de destinatario, el valor predeterminado es el firmante cuando no se proporciona. |
|
Message
|
recipients.message | string |
Message |
|
Contraseña
|
recipients.password | ||
|
¿Silenciado?
|
recipients.muted | boolean |
Esto impedirá que Annature envíe cualquier correspondencia al destinatario |
|
Orden de firma
|
recipients.order | integer |
Orden de firma |
|
Punto de conexión de destino después de que el destinatario haya completado el sobre
|
recipients.redirects.session_completed | string |
Punto de conexión de destino después de que el destinatario haya completado el sobre |
|
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre
|
recipients.redirects.session_declined | string |
Punto de conexión de destino después de que el destinatario haya rechazado firmar el sobre |
|
fields
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
página
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obligatorio
|
recipients.fields.required | boolean |
Obligatorio |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Colaborativo
|
recipients.fields.collaborative | boolean |
Colaborativo |
|
Ancho
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
creado
|
recipients.fields.created | string |
Obtener todos los datos adjuntos de un campo
Obtener datos adjuntos de campo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
envelope_id | True | string |
Id. de sobre |
|
Id. de campo
|
id | True | string |
Id. de campo |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Texto original en
|
original | string | |
|
nombre
|
name | string | |
|
type
|
type | string | |
|
size
|
size | integer | |
|
creado
|
created | string |
Sobre void
Enviar sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
id | True | string |
Id. de sobre |
Desencadenadores
| Desencadenador de eventos: sobre y destinatario |
Desencadena cuando se produce un evento cuando se completan los sobres o las vistas de destinatario |
Desencadenador de eventos: sobre y destinatario
Desencadena cuando se produce un evento cuando se completan los sobres o las vistas de destinatario
Devoluciones
- Body
- WebhookEventContent
Definiciones
WebhookEventContent
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
evento
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
Anulada
|
voided | string | |
|
completado
|
completed | string | |
|
master
|
master | string | |
|
certificate
|
certificate | string | |
|
enviado
|
sent | string | |
|
method
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
Visto
|
viewed | string | |
|
Disminuido
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
fallido
|
failed | string | |
|
Diagnóstico
|
diagnosis | string |