Crear documento via Plantilla

POST https://api.zapsign.com.br/api/v1/models/create-doc/

Este endpoint te permite crear un documento a través de una Plantilla Dinámica. Solo necesitas enviar los datos que van a reemplazar los campos dinámicos de la plantilla en formato JSON, y recibirás la respuesta también en JSON.

Antes de iniciar debes crear la Plantilla en la plataforma web de ZapSign en la sección de Plantillas. Ver tutorial para crear una plantilla dinámica

Encabezado

Nombre	Tipo	Descripción
Authorization*	string	API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Nombre

Tipo

Descripción

Authorization*

string

API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Nombre Tipo Descripción

Nombre	Tipo	Descripción
template_id*	string	El identificador/token de la plantilla dinámica. Ejemplo: https://app.zapsign.co/conta/modelos/{TEMPLATE_ID} Para acceder a tu lista de plantillas, haz clic aquí.
signer_name	string	El nombre del firmante (obligatorio). Si hay más de un firmante, puedes agregarlos más tarde usando el endpoint "Adicionar firmante".
signer_email	string	El correo electrónico del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el correo, el firmante deberá escribirlo durante la firma.
signer_phone_country	String	El indicativo de país del celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde.
signer_phone_number	String	El número de celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el campo, el firmante deberá escribirlo durante la firma.
data[]['de']	string	La variable a reemplazar. Ej: "{{Nombre completo}}"
data[]['para']	string	El valor con el que reemplazar la variable. Ej: "John Doe"
signer_has_incomplete_fields	bolean	Si se establece como `true`, el firmante será redirigido a completar el formulario de la plantilla antes de firmar el documento. Por defecto: `false`.
lang	string	Idioma del documento. Posibles valores: "pt-br" (portugués), "es" (español), "en" (inglés), "fr" (francés) Por defecto: "pt-br"
disable_signer_emails	boolean	Si deseas desactivar todos los correos electrónicos enviados a los firmantes, envía este parámetro como true. Por defecto: false
brand_logo	string	Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el logo en una URL pública. Valor por defecto: ""
brand_primary_color	string	Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el color de los botónes en este parámetro en formato rgb orhexadecimal. Ej: "#0011ee". Valor por defecto: ""
brand_name	string	Para personalizar el remitente de los correos, envia el nombre de tu marca en este parámetro. Por ejemplo, si escribes "Empresa ABC", el firmante recibirá el correo "Empresa ABC via ZapSign". Máximo de 100 carácteres. Valor por defecto: ""
external_id	string	Identificar del documento en tu aplicación. Valor por defecto: ""
folder_path	string	Especifica la ruta de la carpeta dentro de ZapSign donde se guardará el documento. Si las carpetas no existen, se crearán automáticamente. Ej.: "/api/" o "/folder1/folder2/folder3/". Valor por defecto: "/" (sin folder).
created_by	string	Correo electrónico del usuario que se definirá como creador del documento, con fines organizativos internos. Si el correo no existe o no es un usuario de tu cuenta, este parámetro se ignorará. Valor por defecto: "" (el dueño del documento será el propietario de la cuenta).
send_automatic_email	boolean	Si se establece en true, ZapSign enviará automáticamente un correo al firmante con el enlace para firmar el documento. Por defecto es false
send_automatic_whatsapp	boolean	Si se establece en true, ZapSign enviará automáticamente un mensaje por WhatsApp al firmante con el enlace para firmar el documento. Tiene un costo adicional de $0,1 USD (5 créditos) Por defecto es false
custom_message	string	(sólo si send_automatic_email: true). Si send_automatic_email es true, puedes personalizar el mensaje del correo enviado al firmante. Ejemplo: "Hola [Nombre], \n Este es tu contrato de empleo. \n Saludos, Equipo XPTO". El símbolo \n sirve para saltos de línea.
reminder_every_n_days	integer	Intervalo de días entre recordatorios que se enviarán a los firmantes, mientras no hayan firmado el documento. El máximo son 6 intentos de recordatorio. Obs: Este campo solo aplica si send_automatic_whatsapp o send_automatic_email están activados. Ejemplo: Si se establece en 8, se enviará un recordatorio cada 7 días.
allow_refuse_signature	boolean	Si se establece en true, los firmantes tendrán la opción de rechazar la firma. Valor por defecto: false.
disable_signers_get_original_file	boolean	Si se establece en true, los firmantes no podrán descargar el documento original. Valor por defecto: false.
send_automatic_whatsapp_signed_file	boolean	Si se establece en true, ZapSign enviará un mensaje por WhatsApp al firmante con el enlace al documento firmado. Recuerda que se deben tener créditos para enviar por WhatsApp (costo de $0,1 USD). Por defecto es false

template_id*

string

El identificador/token de la plantilla dinámica.

Ejemplo: https://app.zapsign.co/conta/modelos/{TEMPLATE_ID}

Para acceder a tu lista de plantillas, haz clic aquí.

signer_name

string

El nombre del firmante (obligatorio). Si hay más de un firmante, puedes agregarlos más tarde usando el endpoint "Adicionar firmante".

signer_email

string

El correo electrónico del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el correo, el firmante deberá escribirlo durante la firma.

signer_phone_country

String

El indicativo de país del celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde.

signer_phone_number

String

El número de celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el campo, el firmante deberá escribirlo durante la firma.

data[]['de']

string

La variable a reemplazar.

Ej: "{{Nombre completo}}"

data[]['para']

string

El valor con el que reemplazar la variable. Ej: "John Doe"

signer_has_incomplete_fields

bolean

Si se establece como true, el firmante será redirigido a completar el formulario de la plantilla antes de firmar el documento. Por defecto: false.

lang

string

Idioma del documento. Posibles valores:

"pt-br" (portugués), "es" (español), "en" (inglés), "fr" (francés)

Por defecto: "pt-br"

disable_signer_emails

boolean

Si deseas desactivar todos los correos electrónicos enviados a los firmantes, envía este parámetro como true. Por defecto: false

brand_logo

string

Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el logo en una URL pública.

Valor por defecto: ""

brand_primary_color

string

Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el color de los botónes en este parámetro en formato rgb orhexadecimal. Ej: "#0011ee". Valor por defecto: ""

brand_name

string

Para personalizar el remitente de los correos, envia el nombre de tu marca en este parámetro. Por ejemplo, si escribes "Empresa ABC", el firmante recibirá el correo "Empresa ABC via ZapSign". Máximo de 100 carácteres. Valor por defecto: ""

external_id

string

Identificar del documento en tu aplicación.

Valor por defecto: ""

folder_path

string

Especifica la ruta de la carpeta dentro de ZapSign donde se guardará el documento. Si las carpetas no existen, se crearán automáticamente.

Ej.: "/api/" o "/folder1/folder2/folder3/".

Valor por defecto: "/" (sin folder).

created_by

string

Correo electrónico del usuario que se definirá como creador del documento, con fines organizativos internos. Si el correo no existe o no es un usuario de tu cuenta, este parámetro se ignorará.

Valor por defecto: "" (el dueño del documento será el propietario de la cuenta).

send_automatic_email

boolean

Si se establece en true, ZapSign enviará automáticamente un correo al firmante con el enlace para firmar el documento. Por defecto es false

send_automatic_whatsapp

boolean

Si se establece en true, ZapSign enviará automáticamente un mensaje por WhatsApp al firmante con el enlace para firmar el documento. Tiene un costo adicional de $0,1 USD (5 créditos)

Por defecto es false

custom_message

string

(sólo si send_automatic_email: true).

Si send_automatic_email es true, puedes personalizar el mensaje del correo enviado al firmante. Ejemplo: "Hola [Nombre], \n Este es tu contrato de empleo. \n Saludos, Equipo XPTO". El símbolo \n sirve para saltos de línea.

reminder_every_n_days

integer

Intervalo de días entre recordatorios que se enviarán a los firmantes, mientras no hayan firmado el documento. El máximo son 6 intentos de recordatorio.

Obs: Este campo solo aplica si send_automatic_whatsapp o send_automatic_email están activados. Ejemplo: Si se establece en 8, se enviará un recordatorio cada 7 días.

allow_refuse_signature

boolean

Si se establece en true, los firmantes tendrán la opción de rechazar la firma.

Valor por defecto: false.

disable_signers_get_original_file

boolean

Si se establece en true, los firmantes no podrán descargar el documento original.

Valor por defecto: false.

send_automatic_whatsapp_signed_file

boolean

Si se establece en true, ZapSign enviará un mensaje por WhatsApp al firmante con el enlace al documento firmado. Recuerda que se deben tener créditos para enviar por WhatsApp (costo de $0,1 USD).

Por defecto es false

{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contracto de trabajo",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "Maria Perez",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null
        }
    ],
    "answers": [ // list of variables and responses in the dynamic model (if the document was created using a dynamic model).
        {
            "variable": "Nombre completo",
            "value": "Maria Perez"
        },
        {
            "variable": "Documento de identidad",
            "value": "111.111.111"
        }
    ]
}

Request

Response

Después de una solicitud exitosa, recibirás una respuesta similar a esta:

Advertencia: los enlaces original_file y signed_file son temporales y caducan en 60 minutos. Si tu sistema necesita guardar esos enlaces, se recomienda almacenarlos en tu propio CDN o llamar al endpoint de Detalle del documento cada vez que tu usuario necesite una URL válida que caduque en más de 60 minutos.

{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contrato de trabajo",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.co/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "Maria Perez",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null,
            "resend_attempts": null
        }
    ],
    "answers": [
        {
            "variable": "FULL NAME",
            "value": "Foo bar"
        },
        {
            "variable": "SOCIAL SECURITY NUMBER",
            "value": "999-99-XXXX"
        },
        {
            "variable": "FULL ADDRESS",
            "value": "2989 Heller Crossing Apt. 023 - Springfield, NY / 13347"
        }
    ]
}

Link de firma

En la respuesta de la solicitud, cada firmante va a tener un singer_url que es el link para que firmen el documento. Si no enviaste el documento por los canales de ZapSign (send_automatic_email o send_automatic_whatsapp) debes enviar el enlace a los firmantes.

¿Más de un firmante?

Si quieres adicionar más firmantes, después de crear el documento con este Endpoint usa el endpoint Adicionar firmante para configurar los otros firmantes.

PreviousCrear documento via Upload NextAdicionar documento (sobre)

Last updated 4 days ago