Casos de uso
- Personalización de correos: Personaliza los encabezados y el texto del cuerpo de los correos de invitación a firma
- Información de contacto del equipo: Establece un correo del equipo para preguntas de soporte de los destinatarios
- Gestión de zona horaria: Configura la zona horaria para las visualizaciones de fecha/hora y recordatorios
- Aplicaciones multi-tenant: Separa la configuración por espacio de trabajo para soluciones de marca blanca
Consulta la guía sobre Límites de tasa.
Obtener configuración del espacio de trabajo
Recupera la configuración actual del espacio de trabajo, incluyendo plantillas de correo, correo del equipo y configuración de zona horaria.Endpoint
Parámetros
workspace_id(string, requerido) - UUID del espacio de trabajo
Ejemplo - cURL
Respuesta (200 OK)
La respuesta incluye campos adicionales más allá de la configuración de correo:
show_qr_code, require_otp_verification, require_terms_acceptance, allow_presigning_download, configuraciones de color, signing_button_label_overrides, configuraciones de la página de finalización, y más. Esta guía se enfoca en el subconjunto de plantillas de correo y marca. Consulta la referencia de API para el esquema completo de respuesta.Encabezados de límite de tasa
Actualizar configuración del espacio de trabajo
Actualiza la configuración del espacio de trabajo. Puedes actualizar uno o más campos; solo los campos proporcionados serán actualizados.Endpoint
Parámetros
workspace_id(string, requerido) - UUID del espacio de trabajo
Cuerpo de la solicitud
Todos los campos son opcionales; incluye solo los campos que deseas actualizar:Descripción de campos
signing_request_email_header(string, opcional) - Texto personalizado del encabezado para correos de firma (máximo 500 caracteres)signing_request_email_body(string, opcional) - Texto personalizado del cuerpo para correos de firma (máximo 50000 caracteres)team_email(string, opcional) - Dirección de correo electrónico válida para soporte del destinatariotimezone(string, opcional) - Identificador de zona horaria IANA
Ejemplo - cURL
Respuesta (200 OK)
Devuelve la configuración actualizada del espacio de trabajo:Encabezados de límite de tasa
Ejemplos de implementación
Node.js (Express) - Obtener configuración
Node.js (Express) - Actualizar configuración
Python (Flask) - Obtener configuración
Python (Flask) - Actualizar configuración
React - Componente de gestión de configuración
Personalización de plantillas de correo
Firma admite dos niveles de personalización de correo que comparten el mismo motor de marcadores: los campossigning_request_email_header / signing_request_email_body en este endpoint de configuración (que se aplican a los correos de invitación a firma y de siguiente firmante, incluyendo reenvíos manuales de ambos), y un editor de Plantillas de Correo más completo por tipo en la página de Configuración del espacio de trabajo, que permite personalizar el asunto y el cuerpo de forma independiente para cada tipo de correo: invitación, siguiente firmante, expiración, cancelación, rechazo, finalización y notificaciones de cambio de identidad.
Referencia de variables de plantilla
Los marcadores no distinguen entre mayúsculas y minúsculas y también aceptan la sintaxis legacy de
[corchetes] (por ejemplo [signer_name]) junto con la sintaxis de {{llaves}}. Un marcador sin valor para un correo dado simplemente se resuelve como vacío; las plantillas nunca muestran un {{variable_faltante}} sin procesar.Disponibilidad de variables por tipo de correo
Las variables de firmante, documento, equipo y empresa se resuelven para todos los tipos de correo. Tres variables son la excepción:Los campos
signing_request_email_header / signing_request_email_body en este endpoint de configuración solo afectan a los correos de invitación y de siguiente firmante. Para personalizar los correos de expiración, cancelación, rechazo, finalización o cambio de identidad, utiliza el editor de Plantillas de Correo por tipo en la página de Configuración del espacio de trabajo.Logo de la empresa ({{company_logo}})
{{company_logo}} se resuelve a través de una cadena de respaldo:
- Logo del espacio de trabajo: se usa si el espacio de trabajo tiene su propio logo cargado (se renderiza con el nombre del espacio de trabajo como texto
altde la imagen). - Logo de la empresa: de lo contrario, recurre al logo de la empresa matriz.
- Oculto: si ninguno está configurado, el marcador se resuelve como vacío; no se renderiza ninguna imagen rota.
max-width: 200px; max-height: 120px. El límite de altura evita que logos inusualmente altos empujen el resto del correo debajo del pliegue.
Código QR en correos ({{signing_qr_code}})
{{signing_qr_code}} solo se completa en los correos de invitación a firma y de siguiente firmante. Permite al destinatario escanear el código para continuar firmando en otro dispositivo en lugar de hacer clic en un enlace. Si se muestra o no, se controla mediante la configuración show_qr_code que se propaga en cascada:
- Configuración a nivel de solicitud de firma (si se estableció explícitamente)
- Configuración a nivel de espacio de trabajo:
show_qr_codeen este endpoint de configuración - Valor predeterminado a nivel de empresa
show_qr_code como true o false a nivel de espacio de trabajo mediante PUT /workspace/{workspace_id}/settings, o déjalo sin establecer (null) para heredar el valor predeterminado de la empresa.
Correo del espacio de trabajo ({{team_email}} / {{workspace_email}})
team_email es un campo a nivel de espacio de trabajo, configurado en este endpoint de configuración (o desde la página de Configuración del espacio de trabajo, bajo Correo de Contacto del Equipo). Si no se establece, recurre a support@firma.dev.
team_email es solo un valor de visualización; se sustituye donde sea que {{team_email}} o {{workspace_email}} aparezca en una plantilla. No se usa como la dirección Reply-To del correo; las respuestas de los destinatarios van a la dirección de envío de Firma, no a team_email.team_email también tiene un segundo rol no relacionado: para las notificaciones de cambio de identidad, es el destinatario real. Firma envía un correo a tu equipo a esta dirección cuando un firmante cambia su nombre durante el flujo, recurriendo al correo del propietario de la cuenta si team_email no está configurado.
Mejores prácticas
Encabezado del correo (máximo 500 caracteres):- Mantenlo conciso y orientado a la acción
- Indica claramente el propósito (“Firma tu acuerdo”, “Revisa el documento”)
- Evita texto genérico como “Tienes una notificación”
- Explica qué necesita hacer el destinatario
- Incluye información de contacto de soporte
- Establece expectativas (urgencia, fecha límite si aplica)
- Mantén un tono profesional pero amigable
Ejemplos de plantillas
Servicios profesionales:Zonas horarias compatibles
La configuración del espacio de trabajo admite todos los identificadores de zona horaria IANA. Zonas horarias comunes:Estados Unidos
America/New_York- Hora del EsteAmerica/Chicago- Hora CentralAmerica/Denver- Hora de MontañaAmerica/Los_Angeles- Hora del PacíficoAmerica/Anchorage- Hora de AlaskaPacific/Honolulu- Hora de Hawái
Europa
Europe/London- GMT/BSTEurope/Paris- Hora de Europa CentralEurope/Berlin- Hora de Europa CentralEurope/Madrid- Hora de Europa CentralEurope/Rome- Hora de Europa Central
Asia Pacífico
Asia/Tokyo- Hora Estándar de JapónAsia/Shanghai- Hora Estándar de ChinaAsia/Singapore- Hora de SingapurAsia/Dubai- Hora Estándar del GolfoAustralia/Sydney- Hora del Este de Australia
Américas
America/Toronto- Hora del Este (Canadá)America/Vancouver- Hora del Pacífico (Canadá)America/Mexico_City- Hora Central (México)America/Sao_Paulo- Hora de Brasilia
Límites de tasa
Obtener configuración del espacio de trabajo
- Límite: 200 solicitudes por minuto
- Caso de uso: Lecturas frecuentes para visualizaciones de panel
- Recomendación: Almacena en caché la configuración del lado del cliente durante 5-10 minutos
Actualizar configuración del espacio de trabajo
- Límite: 120 solicitudes por minuto
- Caso de uso: Cambios de configuración del administrador
- Recomendación: Aplica debounce a las actualizaciones en la interfaz (espera 1-2 segundos después de que el usuario deje de escribir)
Encabezados de límite de tasa
Cada respuesta incluye:Manejo de límites de tasa
Si excedes el límite:- Implementa caché del lado del cliente
- Aplica debounce a las actualizaciones frecuentes
- Verifica
X-RateLimit-Remainingantes de hacer solicitudes - Implementa retroceso exponencial para reintentos
Respuestas de error
400 Bad Request - Error de validación
Datos de entrada inválidos (por ejemplo, correo mal formado, zona horaria inválida):401 Unauthorized
Clave API inválida o faltante:403 Forbidden
No tienes acceso a este espacio de trabajo (empresa diferente o permisos insuficientes):404 Not Found
El espacio de trabajo no existe o fue eliminado:429 Too Many Requests
Límite de tasa excedido:X-RateLimit-Reset (marca de tiempo ISO 8601) para saber cuándo puedes reintentar.
Mejores prácticas multi-tenant
Para aplicaciones multi-tenant (múltiples espacios de trabajo):1. Almacenar configuración en caché por espacio de trabajo
2. Validar acceso al espacio de trabajo
Siempre verifica que el usuario autenticado tenga acceso al espacio de trabajo:3. Registro de auditoría
Registra todos los cambios de configuración para cumplimiento:4. Configuración predeterminada al crear espacios de trabajo
Establece valores predeterminados razonables al crear nuevos espacios de trabajo:Solución de problemas
La configuración no se aplica a los correos
Síntoma: La configuración actualizada no aparece en los correos de firma Posibles causas:- La caché de plantillas de correo no se limpió
- Se usó un ID de espacio de trabajo incorrecto
- Las actualizaciones no se guardaron (verifica la respuesta de la API)
- Verifica que la actualización fue exitosa (comprueba la respuesta 200)
- Prueba con una nueva solicitud de firma (no un borrador existente)
- Verifica que el ID del espacio de trabajo coincida con la solicitud de firma
Error de zona horaria inválida
Síntoma: Error 400 al establecer la zona horaria Solución: Usa identificadores de zona horaria IANA (por ejemplo,America/New_York). La API solo valida el formato (letras, guiones bajos, barras); abreviaturas como EST pasan la validación pero pueden no comportarse correctamente para las transiciones de horario de verano. Siempre usa el nombre completo de la zona IANA.
Error de validación del correo del equipo
Síntoma: Error 400 al actualizar el correo del equipo Solución: Asegúrate de que el formato del correo sea válido (contiene @ y dominio)Límite de tasa excedido
Síntoma: Errores 429 al actualizar la configuración Solución:- Implementa debounce en los campos de formulario
- Almacena la configuración en caché del lado del cliente
- Espera hasta
X-RateLimit-Resetantes de reintentar
Consulta la guía sobre Límites de tasa.
Referencia de API
Para detalles completos sobre operaciones de espacios de trabajo, consulta:Gestión de Espacios de Trabajo
- Listar espacios de trabajo - Obtener todos los espacios de trabajo (200 sol/min)
- Crear espacio de trabajo - Crear nuevo espacio de trabajo (120 sol/min)
- Actualizar espacio de trabajo - Actualizar detalles del espacio de trabajo (120 sol/min)
Configuración del Espacio de Trabajo
- Obtener configuración del espacio de trabajo - Recuperar configuración actual (200 sol/min)
- Actualizar configuración del espacio de trabajo - Actualizar plantillas de correo y preferencias (120 sol/min)
Endpoints Relacionados
- Generar token JWT para plantillas - Para editor de plantillas embebido (120 sol/min)
- Crear plantilla - Crear plantillas por espacio de trabajo (120 sol/min)
- Crear solicitud de firma - Enviar documentos con marca del espacio de trabajo (120 sol/min)
Próximos pasos
- Crear espacios de trabajo para aplicaciones multi-tenant
- Enviar solicitudes de firma con correos personalizados
- Configurar webhooks para rastrear la actividad del espacio de trabajo
- Editor de plantillas embebible con autenticación JWT para integraciones embebidas