Firma en lote via API

Batch sign via API

POST https://api.zapsign.com.br/api/v1/sign/

Si alguien de tu empresa necesita firmar muchos documentos en ZapSign, una excelente opción es realizar esta firma de manera programada a través de la API.

Requisitos previos:

  1. Solo puedes firmar mediante API con usuarios dentro de tu cuenta. Esto significa que los firmantes deben estar registrados como usuarios en tu cuenta, configurados desde la sección de Ajustes > Organización > Usuarios. No es posible firmar para terceros o clientes externos que no sean usuarios de tu cuenta.

  2. La firma vía API no consume créditos (es gratuita). Sin embargo, necesitas tener un Plan API activo para usar este endpoint, incluyendo la firma de documentos de prueba o en sandbox.

  3. La firma en lote solo funciona con autenticación de "firma en pantalla". Actualmente, esta funcionalidad está disponible únicamente para documentos que tengan la autenticación mediante firma en pantalla como único método. ¡Estamos trabajando para habilitar la firma en lote para documentos con otros métodos de autenticación también!

Con esta funcionalidad, podrás ahorrar tiempo y hacer que el proceso de firma sea más eficiente para tu equipo. 🚀

Encabezado

NombreTipoDescripción

Authorization*

string

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

Request Body

NombreTipoDescripción

user_token

string

El token del usuario que va a firmar. La persona debe estar registrada como usuario en tu cuenta de ZapSign y debe compartir contigo su token que se encuentra en Ajustes > Perfil > Seguridad.

signer_tokens[]

array

Token del firmante que se encuentra en la respuesta después de crear un documento.

Request

Response

{"message":"Documento(s) assinado(s) com sucesso. Lembrete: este endpoint é assíncrono, então aguarde os PDF finais ficarem prontos via webhooks ou confira-os daqui alguns minutos."}

¿Dónde encuentro el token del usuario?

El usuario debe iniciar en la cuenta de ZapSign y dirigirse a la sección de Ajustes > Mi Perfil > Seguridad y activar el switch al lado de "Firma a través de API". Debe copiar el código alfanúmerico que se muestra en la sección.

¿Cómo obtengo el token del firmante?

Cuando se crea un documento en ZapSign, cada firmante tiene un token asociado. Copia ese token generado por ZapSign que se encuentra en el objeto de Signer, no te confundas con el token del documento.

Nota: si sólo vas a firmar un documento a la vez, sólo inserta un arreglo con un sólo token del firmante (signer_token). Ej: ["123-abc-456-def"]

404 errores

Si intentas hacer una solicitud con un user_token o signer_token que no existen, vas a recibir un error 404 (NOT FOUND). Si esto ocurre, revisa que no estes tomando el token del documento en vez del token del firmante.

Endpoint asíncrono

Este endpoint es asíncrono, lo que significa que puedes enviar la solicitud para que los documentos se firmen y recibirás una respuesta casi inmediata de ZapSign. A medida que los documentos estén listos, tu aplicación irá recibiendo los webhooks uno por uno.

Last updated