Saltar al contenido

API para desarrolladores · Actualizado

Integra la firma dentro de tu propio producto.

Crea documentos a partir de un PDF, un archivo de Word o una plantilla, envíalos a firmar, sigue su estado y recibe webhooks cuando se firmen, todo desde tu código.

API REST

Webhooks

Claves de API

¿La API de eSignSimple ya está disponible?

Tu propio software ya puede crear documentos, enviarlos a firmar, seguir su estado y descargar las copias firmadas sin que nadie entre en un panel. La API REST está en https://esignsimple.com/api/v1, y la referencia completa con ejemplos de peticiones y respuestas está en nuestra página para desarrolladores.

Los firmantes a los que llegas a través de la API tienen exactamente la misma experiencia de firma sin cuenta y las mismas pruebas que los documentos enviados desde el panel: un registro de auditoría, un certificado de finalización y un hash SHA-256 que cualquiera puede comprobar en nuestra página pública de verificación.

¿Cómo funciona la API?

Crea un documento con POST /documents. Envías una petición multipart con el PDF y una parte JSON que enumera los firmantes y los campos, cuyas posiciones se indican como fracciones de la página, así que no tienes que preocuparte por puntos PDF ni tamaños de página. El documento se envía de inmediato, o se guarda como borrador si pasas send:false.

¿Ya tienes una plantilla en el panel? POST /templates/{id}/send rellena los firmantes y la envía. GET /documents lista tus documentos con filtro de estado y paginación por cursor mediante before. GET /documents/{id} devuelve el estado, los firmantes y el registro de auditoría completo, y GET /documents/{id}/download devuelve el PDF firmado una vez completado el documento, o el original con ?file=original.

También puedes anular un documento en curso con POST /documents/{id}/void, eliminar uno con DELETE /documents/{id} y consultar tu plan y tu uso actual con GET /me.

¿Cómo funcionan la autenticación y las claves de API?

Cada petición usa una clave de API Bearer. Las claves se crean y revocan en Ajustes → Desarrolladores. Una clave se muestra una sola vez al crearla y solo guardamos un hash, así que cópiala de inmediato en tu gestor de secretos. Si una clave se filtra, revócala y crea otra; no hay que cambiar nada más.

La misma API acepta también tokens de ID de Firebase, que es lo que usará nuestra próxima app móvil. Es una decisión deliberada: construimos nuestras propias apps sobre la misma API pública que usas tú, así que se pone a prueba cada día.

¿Qué webhooks puedes recibir?

En lugar de consultar una y otra vez, registra un endpoint HTTPS para tu cuenta y te avisaremos cuando ocurra algo. Los eventos son document.completed, document.declined, document.voided y signer.signed.

Cada entrega va firmada con HMAC-SHA256 y la firma se envía en la cabecera esign-signature, para que puedas confirmar que la petición viene realmente de nosotros antes de actuar. Si tu endpoint falla, reintentamos una vez. Nuestro consejo: trata los webhooks como un disparador y llama a GET /documents/{id} para obtener el estado de referencia.

¿Qué se construye con la API?

Un CRM o una herramienta de presupuestos que envía un contrato en cuanto una oportunidad se marca como ganada. Un sistema de RR. HH. que envía un paquete de incorporación desde una plantilla cuando se confirma una contratación. Una herramienta inmobiliaria que envía un contrato de arrendamiento y archiva el PDF firmado en la ficha de la vivienda cuando llega document.completed. Un script interno que evita que alguien copie a mano filas de una hoja de cálculo en contratos.

Si envías unos pocos documentos a la semana, probablemente no necesites la API para nada. Las plantillas, el envío masivo y los formularios web del panel te bastarán con mucho menos esfuerzo.

¿Cuánto cuesta la API?

No hay un plan de API aparte. Se aplican los mismos límites que en la aplicación web: el plan Gratis incluye 5 documentos al mes y Personal es ilimitado (consulta los precios). Los documentos creados a través de la API cuentan exactamente igual que los enviados desde el panel.

Los grandes proveedores como DocuSign, Dropbox Sign y Adobe suelen cobrar sus API por separado de los planes de usuario, a menudo según volúmenes anuales de sobres, y los planes de API de entrada pueden costar bastante más que sus suscripciones estándar. Consulta sus webs para ver los precios actuales.

¿Qué no está incluido todavía?

Somos honestos con lo que falta. Todavía no hay firma integrada en iframe, así que los firmantes siguen firmando mediante el enlace que les enviamos por correo. No hay SDK oficiales; la API es HTTP y JSON sin más, así que funciona con cualquier lenguaje que tenga un cliente HTTP. No hay un entorno sandbox separado, así que haz las pruebas con una cuenta gratuita y tus propias direcciones de correo. Todo esto está en nuestra hoja de ruta.

¿Por qué empezamos con una API pequeña?

Empezamos acotados a propósito. Una API pequeña que resuelve bien el flujo habitual, con límites previsibles y sin llamada comercial, es más útil que una superficie enorme que tarda semanas en integrarse. Si echas algo en falta, cuéntanos qué estás construyendo; las integraciones reales deciden lo próximo que añadimos.

¿Qué endpoints de la API existen hoy?

EndpointQué haceUso típico
POST /documentsSube un PDF con firmantes y campos, y lo envía o lo guarda como borradorEnviar un contrato generado desde tu app
POST /templates/{id}/sendEnvía una plantilla del panel a firmantes concretosPaquete de incorporación al confirmar una contratación
GET /documents y GET /documents/{id}Lista documentos o lee el estado, los firmantes y el registro de auditoríaSincronizar el estado con un CRM
GET /documents/{id}/downloadDescarga el PDF firmado (o el original)Archivar la copia firmada en un registro
POST /documents/{id}/void y DELETE /documents/{id}Cancela o elimina un documentoRetirar una oferta o limpiar borradores
GET /mePlan y uso de este mesAvisar antes de llegar al límite del plan Gratis

Preguntas frecuentes

¿eSignSimple tiene API?

Sí. La API REST está disponible en https://esignsimple.com/api/v1 con claves de API Bearer y webhooks. La referencia está en nuestra página para desarrolladores.

¿Cuánto cuesta la API?

No hay precios aparte para la API. Se aplica tu plan normal: Gratis incluye 5 documentos al mes y Personal es ilimitado.

¿Cómo consigo una clave de API?

Créala en Ajustes → Desarrolladores. Se muestra una sola vez y se guarda cifrada con hash, así que guárdala enseguida. Puedes revocar las claves en cualquier momento.

¿Qué eventos de webhook hay disponibles?

document.completed, document.declined, document.voided y signer.signed, firmados con HMAC-SHA256 en la cabecera esign-signature, con un reintento.

¿Ofrecéis firma integrada, SDK o un sandbox?

Todavía no. Los tres están en nuestra hoja de ruta. Hoy los firmantes firman mediante un enlace enviado por correo, y tú llamas a la API por HTTP sin más.

Lecturas relacionadas

Consigue la firma de tu próximo documento hoy.

Empieza con 5 documentos gratis al mes. Sin tarjeta.