eFirma API

Plantillas

Objeto Plantilla

Un objeto del tipo Plantilla contiene los siguientes atributos:

Nombre Tipo de dato Descripción
id String El id único de la plantilla en nuestro sistemas.
ref String El nombre de referencia del documento.
custom_fields []Object Una lista de objetos del tipo CustomField en formato JSON.

Objeto CustomField

Un objeto del tipo CustomField se utiliza para mantener la relación de los campos personalizados de la plantilla contiene los siguientes atributos:

Nombre Tipo de dato Descripción
name String El nombre del parametro personalizado utilizado en la plantilla.

Obtener una plantilla

Permite obtener los datos de una plantilla que está almacenada en nuestros sistemas.

GET /template/get/:id

Parámetro Tipo de dato Descripción
:id String El id único de la plantilla en nuestro sistemas.

Regresará un objeto Plantilla.

Obtener todas las plantillas

Permite obtener una lista de objectos del tipo Plantilla a las cuales tienes acceso en la cuenta.

GET /template/get_all

Generar documento a partir de una plantilla

Permite generar un documento PDF en nuestros sistemas para su firmado, los parametros deben venir en el BODY con un Header del tipo application/json.

POST /template

Parámetro Tipo de dato Descripción
id String El identificador de la plantilla que se utilizará para generar el documento.
title String El titulo que se le dará al documento.
name String El nombre con el cual se creará el documento.
desc String La descripción que se le dará al documento y vendrá en el correo electrónico de invitación.
signature_type Int Especifica el tipo de firma electrónica a utilizar dentro del documento.
1 = Firma Electrónica Avanzada, 2 = Firma Autógrafa Digital.
users []Object Una lista de objetos del tipo User para indicar los permisos y correos de los usuarios que tendrán acceso al documento, como mínimo debe ser especificado el rol del usuario que está generando el documento.
send_mails Bool En caso de ser falso, no se enviarán los correos de invitación a los usuarios del documento.
idcard_required Bool (Opcional) En caso de ser verdadero, el documento generado requerirá una identificación anexa para poder ser firmado.
allowed_ids [String]Bool (Opcional) Un arreglo indexado donde el indice representa el nombre de la identificación a aceptar y el valor otorgado al indice representa si es permitido el documento para identificarse al firmar. Por ejemplo: { "idcard" : true, "passport" : false, "fmcard" : true }, los indices permitidos son: idcard, passport, fmcard.
expiry_in Int (Opcional) Plazo para la celebración del contrato, el parametro puede ser entre 1 y 90 días. Valor predefinido de 30 días.
callback_url String (Opcional) URL para notificar cuando una acción sea ejercida sobre el documento.
return_url String (Opcional) URL para redirigir al usuario una vez que se firme el documento.
custom_fields [String]String Un arreglo indexado donde el indice representa el nombre del CustomField y el valor otorgado al indice es el valor String del parametro personalizado, el cual se utilizará en la plantilla. Por ejemplo: { "email_org" : "ceo@miorganizacion.com", "email_cliente" : "cliente@email.com"}