Saltar al contenido principal
POST
@firma-dev/sdk

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Cuerpo

application/json
name
string
requerido

Nombre de la plantilla

Maximum string length: 255
Ejemplo:

"Employment Contract Template"

document
string<byte>
requerido

Documento PDF o DOCX codificado en base64. Los archivos DOCX se convierten automáticamente a PDF. Tamaño máximo: 20MB. La API extraerá automáticamente el número de páginas del documento. (mutuamente excluyente con document_id)

Ejemplo:

"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291c..."

description
string

Descripción de la plantilla

Ejemplo:

"Standard employment contract for new hires"

expiration_hours
integer
predeterminado:168

Horas hasta que expire la solicitud de firma

Ejemplo:

168

settings
object
document_id
string<uuid>

ID de un documento subido previamente (mutuamente excluyente con document). Obténlo llamando primero a POST /documents.

Ejemplo:

"123e4567-e89b-12d3-a456-426614174000"

Respuesta

Plantilla creada exitosamente

id
string<uuid>
requerido

Identificador único de la plantilla

name
string
requerido

Nombre de la plantilla

Maximum string length: 255
created_date
string<date-time>
requerido

Marca de tiempo de creación de la plantilla

description
string | null

Descripción de la plantilla

document_url
string<uri>

URL prefirmada al documento PDF. Es una URL firmada con tiempo limitado para acceso seguro; consulta document_url_expires_at para conocer el momento de expiración. Las URLs iniciales son válidas por 7 días; las URLs renovadas son válidas por 1 hora. Solicita una nueva recuperación de la plantilla para obtener una URL nueva si ha expirado.

document_url_expires_at
string<date-time> | null

Marca de tiempo ISO 8601 de cuándo expirará document_url. Después de este momento, la URL devolverá un error de acceso denegado. Vuelve a obtener la plantilla para recibir una nueva URL firmada.

page_count
integer

Número de páginas del documento

Rango requerido: x >= 1
expiration_hours
integer
predeterminado:168

Horas hasta que expiren las solicitudes de firma creadas a partir de esta plantilla

Rango requerido: x >= 1
credit_cost
integer
predeterminado:1

Número de créditos consumidos cuando se envía una solicitud de firma desde esta plantilla. El valor mínimo es 1.

Rango requerido: x >= 1
settings
object

Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).

recipients
object[]

Destinatarios de la plantilla (incluido en GET de una sola plantilla)

fields
object[]

Campos de la plantilla (incluido en GET de una sola plantilla)

updated_date
string<date-time>

Marca de tiempo de la última actualización de la plantilla