Inicio de sesión de Oodrive (versión preliminar)
Conecte y consuma el servicio del inicio de sesión de Oodrive a través de los flujos de trabajo.
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 | Inicio de sesión de Oodrive |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| Correo Electrónico | support-sign@oodrive.com |
| Metadatos del conector | |
|---|---|
| Publicador | Inicio de sesión de Oodrive |
| Sitio web | https://www.oodrive.com/products/oodrive-sign/ |
| Directiva de privacidad | https://www.oodrive.com/privacy-policy/ |
| Categorías | Operaciones de TI; Productividad |
El conector de Oodrive Sign le permite automatizar tareas y administrar fácilmente los procesos sobre el ecosistema de firmas electrónicas. El flujo de trabajo automatizado puede diseñarse para, por ejemplo, crear un nuevo contrato mediante una plantilla, agregar destinatarios automáticamente y enviar el contrato para su firma. También puede administrar todas las agrupaciones, destinatarios, parámetros clave y mucho más. Ofrece a los clientes la posibilidad de reducir el tiempo utilizado para realizar acciones manuales después de todo el proceso de firma. Toda la característica disponible en la aplicación web se puede reproducir en Power Automate mediante el conector.
Prerrequisitos
Necesita una cuenta con un plan de pago en el servicio de Oodrive Sign.
Obtención de credenciales
También debe obtener el token de API, que se puede pedir al servicio de soporte técnico o se puede recuperar en el correo electrónico de bienvenida que se ha enviado al buzón cuando se aplica al servicio de Sign.
Note: If you are a employee, you can get the token by contacting your IT service.
Introducción al conector
Para empezar a usar el conector, primero debe abrir Power Automate con su cuenta de Power Platform.
Note: you'll need to be premium on Power Automate in order to use the connector.
Siga estos pasos para crear un nuevo flujo de trabajo y usar nuestro conector:
- En el entorno de Power Automate, haga clic en la pestaña "crear".
- Elija "Flujo de nube automatizado" o "Flujo de nube instantáneo", según sea necesario.
- Asigne un nombre al nuevo flujo de trabajo y seleccione un desencadenador que se ajuste a sus necesidades. Puede usar uno de los signos de Oodrive.
- Para empezar a usar el conector, agregue una acción desde él, simplemente buscando "Inicio de sesión de Oodrive" en el catálogo.
- La primera vez que agregue una acción o un desencadenador desde nuestro conector, Power Automate le pedirá que se conecte a su entorno: esto es lo que usará el token de API proporcionado por nosotros.
- A continuación, haga clic en Conectar: todo lo que se hace, puede usar tantas acciones del conector que desee.
Problemas y limitaciones conocidos
Para problemas con el inicio de sesión de Oodrive, póngase en contacto con el servicio de soporte técnico.
Errores y soluciones comunes
ERROR HTTP 404
Por lo general, cuando recibe un error 404 con el signo de Oodrive, indica que el recurso que está intentando encontrar no existe en su entorno. Normalmente, puede ser un error en el identificador proporcionado para un contrato específico o un destinatario específico, que no existe. Para resolver el problema, intente usar la acción con un identificador conocido del recurso que intenta obtener.
ERROR HTTP 501
El error HTTP 501 indica que el servicio de Oodrive Sign no reconoce bien la demanda o que ha pasado un tipo incorrecto de datos al servicio. Intente investigar, leyendo la documentación de Sign, en los datos que se pasan a la acción o desencadenador.
Preguntas más frecuentes
1. ¿Cómo puedo cargar un documento en un contrato específico?
Con la acción "Cargar un documento y adjuntarlo a un contrato", puede cargar fácilmente un archivo PDF guardado de forma remota.
El primer paso requiere obtener el contenido del archivo que desea cargar. Puede obtenerlo mediante muchos conectores. Por ejemplo, el contenido del archivo se puede recuperar mediante la acción "Obtener contenido de archivo" del conector de SharePoint.
- Obtenga el contenido del archivo que desea cargar como documento para un contrato específico. En este ejemplo, usamos la acción "Obtener contenido de archivo" del conector de SharePoint Online.
- A continuación, agregue una nueva acción "redactar". Use el cuerpo de salida de la acción "Obtener contenido del archivo" como entrada para la redacción uno.
- Agregue la acción denominada "Cargar un documento y agregarlo a un contrato" desde el conector de inicio de sesión de Oodrive.
- En la entrada "Id. de contrato", especifique el identificador del contrato para el que desea que se adjunte el documento.
- En la entrada "Files", inserte la salida de la acción anterior "Compose"
- En la entrada "Archivos (nombre de archivo)", inserte un nombre para el documento que se cargará.
- Ha terminado de cargar el documento .
2. ¿Puedo ver todos los contratos dentro de mi entorno?
Si el token es un token de "administrador", sí. De lo contrario, solo verá el contrato al que tiene acceso normalmente.
3. Tengo una sugerencia para el conector. ¿Dónde puedo enviarlo?
Puede enviar cualquier sugerencia sobre el conector poniéndose en contacto con el servicio de soporte técnico. Estaremos muy agradecidos por su contribución !
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 |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Agregar un contrato a una agrupación |
Agregue un contrato existente a una agrupación existente. |
| Agregar un destinatario a un contrato |
Adjunte un destinatario existente al contrato. |
| Cargar datos adjuntos y agregarlos a un contrato |
Cargue un nuevo archivo adjunto en el entorno y adjunte a un contrato específico. |
| Cargar un documento y adjuntarlo a un contrato |
Cargue un documento en el entorno y adjunte a un contrato específico. |
| Creación de un contrato |
Cree un nuevo contrato en el entorno. |
| Creación de un lote |
Cree una nueva agrupación con al menos un contrato existente. |
| Crear contrato y enviarlo para la firma |
Todo en una sola operación. Cree contrato, agregue destinatarios, documentos y envíelo para la firma a los destinatarios. |
| Descargar el archivo de prueba de un contrato |
Descargue el archivo de prueba del contrato. |
| Descargar el documento firmado de un contrato |
Recupere un archivo PDF del documento firmado del contrato. |
| Descargar los documentos del contrato |
Recupere un archivo PDF que contenga todos los documentos de un contrato. |
| Detener la transacción de un contrato |
Detenga la transacción del contrato para que pueda modificar documentos de contrato o firmantes. |
| Detener una transacción de agrupación |
Detenga una transacción de agrupación. |
| Eliminar un destinatario del contrato |
Elimine un destinatario de un contrato, por su destinatario para el identificador de contrato. Más información en la documentación. |
| Enumerar los contratos de un lote |
Recuperar todos los contratos de un paquete específico. |
| Enumerar los destinatarios de un contrato |
Recuperar todos los destinatarios de un contrato específico. |
| Enumerar los documentos del contrato |
Recupere todos los documentos enlazados a un contrato. |
| Enumerar todos los destinatarios |
Recupere todos los destinatarios asociados a la licencia actual. |
| Enumerar todos los perímetros |
Recupere todos los perímetros asociados al entorno conectado. |
| Envío de un contrato para que se firme |
Envíe un contrato específico y todos sus documentos para que los destinatarios los firmen. |
| Envío de un lote para la firma |
Envíe un lote para la firma. |
| Obtener el estado de un contrato |
Compruebe el estado de un contrato específico. |
| Obtener firmas de un contrato |
Enumera todas las informaciones de firmas de un contrato específico. |
| Obtener un contrato específico |
Recuperar metadatos de un contrato específico. |
| Obtener un destinatario específico |
Recupere un destinatario específico en la lista guardada de destinatarios del entorno actual. |
| Obtener una lista de todos los contratos |
Recupere todos los contratos de la licencia asociada. |
| Reenviar el correo electrónico de notificación a todos los destinatarios |
Envíe un correo electrónico de notificación a todos los destinatarios de un contrato específico. |
| Reenviar el correo electrónico de notificación a un destinatario |
Envíe un correo electrónico de notificación a un destinatario específico para el contrato. |
| Retirar un contrato |
Establezca el estado del contrato en ABANDONED, incluso si el contrato se envió para la firma. |
| Retirar un lote |
Retirar todo el contrato en un paquete. |
| Validación de contratos en una agrupación |
Counter-sign (validate) all contract in a bundle. |
| Validar un contrato |
Valide (contrafirma) un contrato. |
Agregar un contrato a una agrupación
Agregue un contrato existente a una agrupación existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Id. del paquete para agregar contrato. |
|
Id. de contrato
|
contract_id | integer |
Identificador del contrato que se va a agregar a la agrupación. |
Devoluciones
- Body
- BundleResponse
Agregar un destinatario a un contrato
Adjunte un destinatario existente al contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Id. del contrato que se va a adjuntar al destinatario. |
|
Id. de destinatario
|
recipient_id | integer |
Id. del destinatario que se va a adjuntar al contrato. |
|
|
Modo de firma
|
signature_mode | integer |
Modo de firma. Consulte la documentación para obtener más información. |
|
|
Título del mensaje
|
message_title | string |
Título del mensaje que se va a enviar por correo electrónico si habrá uno. |
|
|
Contenido del mensaje
|
message_body | string |
Cuerpo del mensaje que se va a enviar por correo electrónico si habrá uno. |
|
|
Rango
|
rank | integer |
Lugar del destinatario en el proceso de firma. Rank y Smartrole son mutuamente excluyentes. Elija solo uno de ellos o no en absoluto. |
|
|
Nombre de rol inteligente
|
smartrole | string |
Rol inteligente que se va a asignar al destinatario. Consulte la documentación para obtener más información. |
|
|
Modo de transporte
|
transport_mode | integer |
Modo de transporte de la firma. Consulte la documentación para obtener más información. |
Devoluciones
- response
- array of ContractRecipient
Cargar datos adjuntos y agregarlos a un contrato
Cargue un nuevo archivo adjunto en el entorno y adjunte a un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato para agregar datos adjuntos. |
|
Identificador de definición de contrato
|
contract_definition_id | integer |
Identificador de definición de contrato definido en el entorno. El valor predeterminado es pdfadhoc. |
|
|
Nombre de definición de opción
|
option_definition_name | string |
Nombre de definición. |
|
|
Archivos
|
file | array |
Archivos que se van a agregar como datos adjuntos |
Devoluciones
- Body
- AppendixAdded
Cargar un documento y adjuntarlo a un contrato
Cargue un documento en el entorno y adjunte a un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato al que se va a adjuntar un nuevo documento. |
|
Archivo
|
file | file |
Archivo binario que se va a cargar. |
Devoluciones
- response
- array of DocumentAdded
Creación de un contrato
Cree un nuevo contrato en el entorno.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del contrato
|
name | string |
Nombre del contrato recién creado (obligatorio). |
|
|
Identificador de definición de contrato
|
contract_definition_id | integer |
Identificador de la definición del contrato. Consulte la variable de API de la licencia. El valor predeterminado es la plantilla de AdHoc pdf. |
|
|
Correo electrónico del proveedor
|
vendor_email | string |
Correo electrónico del propietario de la licencia. |
|
|
Fecha de creación
|
date | integer |
Fecha del contrato. Valor predeterminado es Date.Now(). Debe estar en milisegundos. |
|
|
Título del mensaje
|
message_title | string |
Objeto del correo electrónico enviado. Deje vacío para un título predeterminado. |
|
|
Cuerpo del mensaje
|
message_body | string |
Cuerpo del correo electrónico enviado. Deje vacío para un mensaje predeterminado. |
|
|
Mantener el movimiento
|
keep_on_move | boolean |
Activar o no la firma fuera de línea en un dispositivo móvil |
|
|
Cierre automático
|
auto_close | integer |
Especifique si la contrafirma se realiza sin intervención humana. |
|
|
Secuencial
|
sequential | boolean |
Especifique si es secuencial o no. |
|
|
Número de cliente
|
customer_number | string |
Solo para la compatibilidad de aplicaciones móviles heredadas. |
|
|
Lista de perímetros
|
perimeters | array of string | ||
|
Id. de definición de elemento
|
element_definition_id | integer |
Identificador de definición del elemento. |
|
|
Importancia
|
value | string |
Valor de la opción de elemento. |
|
|
Id. de propiedad
|
id | integer |
Identificador de la propiedad personalizada. |
|
|
Clave de propiedad
|
key | string |
Clave de la propiedad personalizada. |
|
|
Marcador de posición de propiedad
|
placeholder | string |
Etiqueta que se muestra al destinatario cuando se invita a rellenar la propiedad. |
|
|
Valor de propiedad
|
value | string |
Valor de la propiedad personalizada. |
|
|
Id. de contrato de propiedad
|
contract_id | integer |
Identificador del contrato asociado a esta propiedad personalizada. |
|
|
Se requiere la propiedad
|
to_fill_by_user | boolean |
Especifique si el usuario necesita rellenar la propiedad o no. |
|
|
Tipo de propiedad
|
field_type | string |
Especifique el tipo de la propiedad personalizada. Más información en la documentación. |
|
|
Opciones de propiedades
|
input_filter | string |
Lista de opciones posibles para la propiedad. |
|
|
El contrato usa la propiedad
|
used_by_contract | boolean |
Establézcalo en true si la información debe aparecer en el documento de contrato. |
|
|
Se requiere la propiedad
|
required | boolean |
Especifique si la propiedad es necesaria o no. |
Devoluciones
- Body
- Contract
Creación de un lote
Cree una nueva agrupación con al menos un contrato existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
contract_id | integer |
Identificador del primer contrato del lote. |
|
|
Mismos firmantes
|
same_signatories | boolean |
Se establece en false si los contratos de la agrupación no tienen el mismo conjunto de firmantes. |
Devoluciones
- Body
- BundleResponse
Crear contrato y enviarlo para la firma
Todo en una sola operación. Cree contrato, agregue destinatarios, documentos y envíelo para la firma a los destinatarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
contract_id | integer |
Identificador del contrato. |
|
|
Fecha de creación
|
date | integer |
Fecha en la que se ha creado el contrato. |
|
|
Dirección de correo electrónico del proveedor
|
vendor_email | string |
Dirección de correo electrónico del propietario de la licencia de Oodrive. |
|
|
Identificador de definición de contrato
|
contract_definition_id | integer |
Identificador de la definición de contrato utilizada para este contrato. |
|
|
Asunto del mensaje
|
message_title | string |
Asunto del correo electrónico cuando se envía para la firma. |
|
|
Cuerpo del mensaje
|
message_body | string |
Cuerpo del correo electrónico cuando se envía para la firma. |
|
|
Nombre del contrato
|
name | True | string |
Nombre principal del documento del contrato. |
|
Firma sin conexión activada
|
keep_on_move | boolean |
Determine si se activa la firma sin conexión en el dispositivo móvil. |
|
|
Fecha de cierre del contrato
|
closed_date | integer |
Fecha de cierre del contrato, si hay alguno. |
|
|
Motivo cancelado del contrato
|
canceled_reason | string |
Motivo de la cancelación, si hay alguno. |
|
|
Cierre automático habilitado
|
auto_close | integer |
Especifique si el contrato se contrasignará automáticamente o necesitará una intervención humana. |
|
|
Está eliminado
|
deleted | integer |
Especifique si el contrato se ha eliminado o no. |
|
|
Clave perimetral
|
Perimeters | string |
Clave del perímetro. |
|
|
Id. de opción
|
id | integer |
Identificador de la opción del contrato. |
|
|
Id. de contrato
|
contract_id | integer |
Id. del contrato enlazado a esta opción. |
|
|
Id. de definición de elemento
|
element_definition_id | integer |
Identificador de la definición de elemento de la opción. |
|
|
Temporizador de sincronización
|
sync_timer | integer |
Temporizador que se usa para el problema de sincronización. |
|
|
Valor de la opción
|
value | string |
Valor de la opción. |
|
|
Último lugar de modificación
|
last_modification_place | string |
Indica dónde tuvo lugar la última modificación. |
|
|
Control de opciones
|
control | string |
Campo de control. |
|
|
Id. de propiedad
|
id | integer |
Identificador de la propiedad personalizada. |
|
|
Clave de propiedad
|
key | string |
Clave de la propiedad personalizada. |
|
|
Marcador de posición de propiedad
|
placeholder | string |
Etiqueta que se muestra al destinatario cuando se invita a rellenar la propiedad. |
|
|
Valor de propiedad
|
value | string |
Valor de la propiedad personalizada. |
|
|
Id. de contrato de propiedad
|
contract_id | integer |
Identificador del contrato asociado a esta propiedad personalizada. |
|
|
Se requiere la propiedad
|
to_fill_by_user | boolean |
Especifique si el usuario necesita rellenar la propiedad o no. |
|
|
Tipo de propiedad
|
field_type | string |
Especifique el tipo de la propiedad personalizada. Más información en la documentación. |
|
|
Opciones de propiedades
|
input_filter | string |
Lista de opciones posibles para la propiedad. |
|
|
El contrato usa la propiedad
|
used_by_contract | boolean |
Establézcalo en true si la información debe aparecer en el documento de contrato. |
|
|
Se requiere la propiedad
|
required | boolean |
Especifique si la propiedad es necesaria o no. |
|
|
Modo de firma
|
signature_mode | integer | ||
|
nombre de pila
|
firstname | string | ||
|
apellido
|
lastname | string | ||
|
Correo electrónico
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
apéndicepartes
|
appendixparts | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
destinatarios
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
contrato
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
Matriz de PDF enlazada al contrato. |
|
Id. de PDF
|
pdfparts.id | integer |
Id. del PDF. |
|
Clasificación en PDF
|
pdfparts.rank | integer |
Rango del PDF. |
|
Tiene SmartFields
|
pdfparts.has_smart_field | boolean |
Especifique si hay campos inteligentes en el contrato. |
|
Tamaño de PDF
|
pdfparts.size | integer |
Tamaño del documento. |
|
Nombre del archivo
|
pdfparts.filename | string |
Nombre del pdf. |
|
apéndicepartes
|
appendixparts | array of object | |
|
id
|
appendixparts.id | integer |
Descargar el archivo de prueba de un contrato
Descargue el archivo de prueba del contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Id. del contrato para descargar el archivo de prueba. |
|
Nombre del archivo de salida
|
filename | string |
Nombre del archivo que se descargará. |
Devoluciones
- response
- file
Descargar el documento firmado de un contrato
Recupere un archivo PDF del documento firmado del contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | integer |
Identificador del contrato que contiene documentos. |
|
Nombre del archivo
|
filename | string |
Nombre que desea asignar al documento descargado. |
Devoluciones
Contenido binario del archivo pdf.
- Binario del documento
- file
Descargar los documentos del contrato
Recupere un archivo PDF que contenga todos los documentos de un contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato para recuperar el archivo pdf. |
|
Nombre del archivo de salida
|
filename | string |
Nombre del archivo que se descargará. |
Devoluciones
- Binario de documentos PDF
- file
Detener la transacción de un contrato
Detenga la transacción del contrato para que pueda modificar documentos de contrato o firmantes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a detener. |
|
Fuerza
|
force | boolean |
Forzar el cierre de la transacción incluso si los firmantes ya han firmado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Especifique si se ha cancelado el contrato. |
Detener una transacción de agrupación
Detenga una transacción de agrupación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Identificador de la agrupación para detener la transacción. |
|
Forzar cierre
|
force | boolean |
Forzar el cierre de la transacción, incluso si los firmantes ya han firmado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Dice que la agrupación se detuvo correctamente. |
Eliminar un destinatario del contrato
Elimine un destinatario de un contrato, por su destinatario para el identificador de contrato. Más información en la documentación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Destinatario del identificador de contrato
|
cfc_id | True | string |
Identificador del destinatario del objeto de contrato que se va a eliminar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Especifique si se quitó correctamente. |
Enumerar los contratos de un lote
Recuperar todos los contratos de un paquete específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Identificador de la agrupación de la que se van a recuperar contratos. |
Devoluciones
- response
- array of ContractInBundle
Enumerar los destinatarios de un contrato
Recuperar todos los destinatarios de un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Id. del contrato para recuperar todos los destinatarios. |
Devoluciones
- response
- array of ContractRecipient
Enumerar los documentos del contrato
Recupere todos los documentos enlazados a un contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato para recuperar documentos. |
Devoluciones
- response
- array of DocumentAdded
Enumerar todos los destinatarios
Recupere todos los destinatarios asociados a la licencia actual.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tamaño
|
size | integer |
Tamaño máximo de la matriz devuelta. |
|
|
Desplazar
|
offset | integer |
Número de secuencia del primer destinatario enumerado. |
|
|
Perímetro
|
perimeter | string |
Busque solo en el perímetro especificado. |
|
|
Obtener propiedades personalizadas
|
get_custom_props | boolean |
Enumerar las propiedades personalizadas de los destinatarios (aumenta el tiempo de respuesta). |
|
|
Obtener perímetros
|
get_perimeters | boolean |
Enumerar los perímetros del destinatario en las respuestas (aumenta el tiempo de respuesta). |
|
|
Filtrar apellidos (contiene)
|
name | string |
Filtre por el apellido. |
|
|
Filtrar correo electrónico (contiene)
|
string |
Filtre por el correo electrónico. |
Devoluciones
- Recipientes
- array of Recipient
Enumerar todos los perímetros
Recupere todos los perímetros asociados al entorno conectado.
Devoluciones
- response
- array of Perimeter
Envío de un contrato para que se firme
Envíe un contrato específico y todos sus documentos para que los destinatarios los firmen.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a enviar para la firma. |
Devoluciones
- Body
- Transaction
Envío de un lote para la firma
Envíe un lote para la firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Identificador de la agrupación que se va a enviar para la firma. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Indica si se ha enviado o no la transacción. |
Obtener el estado de un contrato
Compruebe el estado de un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | integer |
Identificador del contrato para recuperar el estado. |
Devoluciones
- Body
- Transaction
Obtener firmas de un contrato
Enumera todas las informaciones de firmas de un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Id. del contrato para enumerar todas las firmas. |
Devoluciones
Obtener un contrato específico
Recuperar metadatos de un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a recuperar. |
Devoluciones
- Body
- Contract
Obtener un destinatario específico
Recupere un destinatario específico en la lista guardada de destinatarios del entorno actual.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de destinatario
|
id | True | string |
Id. del destinatario que se va a recuperar. |
Devoluciones
- Body
- Recipient
Obtener una lista de todos los contratos
Recupere todos los contratos de la licencia asociada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tamaño de la matriz devuelta
|
size | integer |
Tamaño máximo de la matriz de contrato devuelta. |
|
|
Omitir los primeros n contratos
|
offset | integer |
Número de secuencia de contrato que se omitirá. |
|
|
Mostrar propiedades del contrato
|
get_properties | boolean |
Si es true, las propiedades del contrato se mostrarán en la respuesta. |
|
|
Mostrar perímetros de contrato
|
get_perimeters | boolean |
Si es true, los perímetros del contrato se mostrarán en la respuesta. |
|
|
Creado antes
|
before | integer |
Mostrará el contrato creado antes de la fecha especificada. |
|
|
Creado después de
|
after | integer |
Mostrará el contrato creado después de la fecha especificada. |
|
|
Solo con perímetro
|
perimeter | string |
Enumera los contratos solo en un perímetro determinado. |
|
|
Solo con el estado
|
status | array |
Recupere el contrato solo con el estado especificado. |
Devoluciones
- Productos
- ArrayOfContract
Reenviar el correo electrónico de notificación a todos los destinatarios
Envíe un correo electrónico de notificación a todos los destinatarios de un contrato específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a volver a enviar la notificación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Especifique si la notificación se volvió a enviar correctamente. |
Reenviar el correo electrónico de notificación a un destinatario
Envíe un correo electrónico de notificación a un destinatario específico para el contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a volver a enviar la notificación. |
|
Destinatario del identificador de contrato
|
cfc_id | True | string |
Id. del destinatario del objeto de contrato para enviar una notificación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Especifique si la notificación se volvió a enviar correctamente. |
Retirar un contrato
Establezca el estado del contrato en ABANDONED, incluso si el contrato se envió para la firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Id. del contrato que se va a retirar. |
|
Motivo
|
reason | string |
Motivo de la retirada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Especifique si se ha cancelado el contrato. |
Retirar un lote
Retirar todo el contrato en un paquete.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Id. del lote para retirar todo el contrato. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lograr
|
succeed | boolean |
Dice si se retiró la agrupación. |
Validación de contratos en una agrupación
Counter-sign (validate) all contract in a bundle.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
id | True | string |
Identificador de la agrupación para validar todo el contrato. |
|
Forzar validación
|
force | boolean |
Forzar la validación de contratos si algunos firmantes aún no han firmado (o se han rechazado firmar). |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
Fecha de cierre del estado. |
|
Id. de contrato
|
id | string |
Identificador del contrato detenido. |
Validar un contrato
Valide (contrafirma) un contrato.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
id | True | string |
Identificador del contrato que se va a validar. |
|
Fuerza
|
force | boolean |
Especifique si la validación del contrato debe ser forzada, incluso si algunos firmantes aún no han firmado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Fecha de validación
|
date | string |
Fecha de validación. |
|
Id. de transacción
|
id | string |
Identificador de transacción de la entidad de certificación. |
Desencadenadores
| Cuando cambia el estado de un contrato |
Esta operación se desencadena cada vez que el estado de un contrato ha cambiado. |
Cuando cambia el estado de un contrato
Esta operación se desencadena cada vez que el estado de un contrato ha cambiado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
descripción
|
description | string |
descripción |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
perímetro
|
perimeter | array of integer |
perímetro |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
contractId
|
contractId | integer |
contractId |
|
marca de tiempo
|
timestamp | integer |
marca de tiempo |
|
contractStatus
|
contractStatus | string |
contractStatus |
Definiciones
ArrayOfContract
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
Contract |
Contrato
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de contrato
|
contract_id | integer |
Identificador del contrato. |
|
Fecha de creación
|
date | integer |
Fecha en la que se ha creado el contrato. |
|
Token de documento
|
document_token | string |
Token del documento principal del contrato. |
|
Dirección de correo electrónico del proveedor
|
vendor_email | string |
Dirección de correo electrónico del propietario de la licencia de Oodrive. |
|
Está cerrado
|
closed | boolean |
Especifique si el contrato está cerrado o no. |
|
Estado del contrato
|
status | string |
Estado actual del contrato. |
|
Identificador de definición de contrato
|
contract_definition_id | integer |
Identificador de la definición de contrato utilizada para este contrato. |
|
Asunto del mensaje
|
message_title | string |
Asunto del correo electrónico cuando se envía para la firma. |
|
Cuerpo del mensaje
|
message_body | string |
Cuerpo del correo electrónico cuando se envía para la firma. |
|
Nombre del contrato
|
name | string |
Nombre principal del documento del contrato. |
|
Firma sin conexión activada
|
keep_on_move | boolean |
Determine si se activa la firma sin conexión en el dispositivo móvil. |
|
Fecha de cierre del contrato
|
closed_date | integer |
Fecha de cierre del contrato, si hay alguno. |
|
Motivo cancelado del contrato
|
canceled_reason | string |
Motivo de la cancelación, si hay alguno. |
|
Número de versión del contrato
|
version_number | integer |
Número de versión del contrato. |
|
Tamaño del contrato
|
size | integer |
Tamaño completo del contrato. |
|
Cierre automático habilitado
|
auto_close | integer |
Especifique si el contrato se contrasignará automáticamente o necesitará una intervención humana. |
|
Está eliminado
|
deleted | integer |
Especifique si el contrato se ha eliminado o no. |
|
Perímetros
|
perimeters | array of ContractPerimeterKey |
Lista de todos los perímetros del contrato (si se consulta). |
|
Options
|
options | array of ContractOption |
Lista de todas las opciones específicas del contrato (si se consultan). |
|
Propiedades personalizadas
|
contract_properties | array of ContractProperty |
Lista de todas las propiedades de contrato opcionales (si se consultan). |
ContractOption
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de opción
|
id | integer |
Identificador de la opción del contrato. |
|
Id. de contrato
|
contract_id | integer |
Id. del contrato enlazado a esta opción. |
|
Id. de definición de elemento
|
element_definition_id | integer |
Identificador de la definición de elemento de la opción. |
|
Temporizador de sincronización
|
sync_timer | integer |
Temporizador que se usa para el problema de sincronización. |
|
Valor de la opción
|
value | string |
Valor de la opción. |
|
Último lugar de modificación
|
last_modification_place | string |
Indica dónde tuvo lugar la última modificación. |
|
Control de opciones
|
control | string |
Campo de control. |
ContractProperty
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de propiedad
|
id | integer |
Identificador de la propiedad personalizada. |
|
Clave de propiedad
|
key | string |
Clave de la propiedad personalizada. |
|
Marcador de posición de propiedad
|
placeholder | string |
Etiqueta que se muestra al destinatario cuando se invita a rellenar la propiedad. |
|
Valor de propiedad
|
value | string |
Valor de la propiedad personalizada. |
|
Id. de contrato de propiedad
|
contract_id | integer |
Identificador del contrato asociado a esta propiedad personalizada. |
|
Se requiere la propiedad
|
to_fill_by_user | boolean |
Especifique si el usuario necesita rellenar la propiedad o no. |
|
Tipo de propiedad
|
field_type | string |
Especifique el tipo de la propiedad personalizada. Más información en la documentación. |
|
Opciones de propiedades
|
input_filter | string |
Lista de opciones posibles para la propiedad. |
|
El contrato usa la propiedad
|
used_by_contract | boolean |
Establézcalo en true si la información debe aparecer en el documento de contrato. |
|
Se requiere la propiedad
|
required | boolean |
Especifique si la propiedad es necesaria o no. |
ContractPerimeterKey
ContractRecipient
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Destinatario del identificador de contrato
|
recipient_for_contract_id | integer |
Identificador único del contrato y el destinatario de la pareja. |
|
Id. de destinatario
|
recipient_id | integer |
Id. del destinatario. |
|
Id. de contrato
|
contract_id | integer |
Identificador del contrato. |
|
Estado de la firma
|
signature_status | string |
Estado de la marca de signo. |
|
Fecha de firma
|
signature_date | integer |
Marca de tiempo de la fecha de la marca de signo. |
|
Modo de firma
|
signature_mode | integer |
Modo de marca de signo. |
|
Título del mensaje
|
message_title | string |
Título del mensaje. |
|
Contenido del mensaje
|
message_body | string |
Cuerpo del mensaje. |
|
Rango
|
rank | integer |
Clasificación en el proceso de inicio de sesión. |
|
Rol inteligente
|
smartrole | string |
Rol inteligente asociado al destinatario. |
|
Modo de transporte
|
transport_mode | integer |
Modo de transporte. |
|
Id. de firma
|
signature_id | string |
Identificador de la firma del destinatario. |
DocumentAdded
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de documento
|
id | integer |
Id. del documento. |
|
Rango
|
rank | integer |
Coloque en la lista de documentos. |
|
Has SmartField
|
has_smart_field | boolean |
Especifique si el documento tiene SmartFields. |
|
Tamaño del documento
|
size | integer |
Tamaño del documento en bytes. |
|
Nombre del documento
|
filename | string |
Nombre del documento. |
Transacción
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de transacción del contrato
|
transaction_id | string |
Especifique el identificador de transacción enlazado al contrato. |
|
Está cerrado
|
is_closed | boolean |
Especifique si el contrato está cerrado. |
|
Nombre del contrato
|
contract_name | string |
Nombre del contrato. |
|
Estado del contrato
|
status | string |
Especifique el estado del contrato. |
Perímetro
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de perímetro
|
id | integer |
Id. del perímetro. |
|
Clave perimetral
|
key | string |
Clave del perímetro (utilizado por contratos). |
|
descripción
|
description | string |
Descripción del perímetro. |
RecipientForContractWithRefusal
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Destinatario del identificador de contrato
|
recipient_for_contract_id | integer |
Id. del objeto que enlazaba el contrato y el destinatario. |
|
Id. de destinatario
|
recipient_id | integer |
Identificador del destinatario de la firma. |
|
Estado de firma
|
signature_status | string |
Estado de la firma. |
|
Fecha de firma
|
signature_date | integer |
Fecha de los últimos cambios de la firma. |
|
Modo de firma
|
signature_mode | integer |
Modo de la firma. |
|
Título del mensaje
|
message_title | string |
Título del mensaje enlazado a la firma del contrato. |
|
Contenido del mensaje
|
message_body | string |
Cuerpo del mensaje enlazado a la firma del contrato. |
|
Rango
|
rank | integer |
Rango del destinatario de la firma en el proceso del contrato. |
|
Nombre de rol inteligente
|
smartrole | string |
Rol del destinatario de la firma en el contrato. |
|
Modo de transporte
|
transport_mode | integer |
Modo de transporte del contrato enlazado a la firma. |
|
Id. de firma
|
signature_id | string |
Identificador de la firma. |
|
Ha denegado
|
has_refusal | boolean |
Especifique si el destinatario rechazó el contrato. |
|
Fecha de última denegación
|
last_refusal_date | integer |
Especifique la fecha de denegación. |
|
Último mensaje de denegación
|
last_refusal_message | string |
Especifique el mensaje de denegación. |
ContractInBundle
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de contrato
|
id | integer |
Identificador del contrato. |
|
Nombre del contrato
|
name | string |
Nombre del contrato. |
|
Tipo de definición de contrato
|
contract_definition_type | string |
Tipo de definición del contrato. |
|
Identificador de definición de contrato
|
contract_definition_id | integer |
Identificador de la definición del contrato. |
|
Nombre de la compañía
|
company_name | string |
Nombre de la empresa enlazada al contrato. |
Destinatario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de destinatario
|
id | integer |
Id. del destinatario. |
|
Civilidad
|
civility | string |
Civilidad del destinatario |
|
Nombre
|
firstname | string |
Nombre del destinatario. |
|
Apellido
|
lastname | string |
Apellido del destinatario. |
|
Dirección principal
|
address_1 | string |
Dirección postal principal del destinatario. |
|
Código postal
|
postal_code | string |
Código postal del destinatario. |
|
City
|
city | string |
Ciudad del destinatario. |
|
Número de teléfono móvil
|
cell_phone | string |
Número de teléfono móvil del destinatario. |
|
Dirección de correo
|
string |
Dirección de correo del destinatario. |
|
|
País
|
country | string |
País del destinatario. |
|
Dirección secundaria
|
address_2 | string |
Dirección postal secundaria del destinatario. |
|
Nombre de la compañía
|
company_name | string |
Nombre de la compañía del destinatario. |
|
Número de teléfono
|
phone | string |
Número de teléfono del destinatario. |
|
Título del Puesto
|
job_title | string |
Título del trabajo del destinatario. |
|
Fecha de nacimiento
|
birthdate | integer |
Fecha de nacimiento (marca de tiempo) del destinatario. |
|
Lugar de nacimiento
|
birthplace | string |
Lugar de nacimiento del destinatario. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
Perímetros
|
perimeters | array of string |
RecipientProperty
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de propiedad
|
id | integer |
Identificador de la propiedad . |
|
Clave de propiedad
|
key | string |
Clave de la propiedad . |
|
Valor de propiedad
|
value | string |
Valor de la propiedad . |
|
Id. de contratista
|
contractor_id | integer |
Id. del contratista. |
|
Temporizador de sincronización
|
sync_timer | integer |
Temporizador de la última sincronización. |
|
Último lugar de modificación
|
last_modification_place | string |
Ubicación de la última modificación. |
ApéndiceAdded
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del apéndice
|
id | integer |
Id. del Apéndice. |
|
Nombre del apéndice
|
filename | string |
Nombre del Apéndice. |
|
Id. de opción del apéndice
|
option_id | integer |
Id. de opción para el Apéndice |
|
Apéndice de tipo de contenido
|
content_type | string |
Content-Type del Apéndice (image/jpeg por ejemplo). |
BundleResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de paquete
|
id | integer |
Id. de la agrupación. |
|
Id. de autor
|
actor_id | integer |
Id. del creador de la agrupación. |
|
Primer identificador de contrato
|
contract_id | integer |
Id. del primer contrato del paquete creado. |
|
Estado de agrupación
|
status | integer |
Estado del lote. |
|
Patrón de agrupación
|
master | integer |
Maestro de la agrupación. |
archivo
Este es el tipo de datos básico "file".