API de Temas
Personaliza la apariencia visual de tus formularios con propiedades de tema granulares.
La API de Temas te permite leer y actualizar el tema visual completo de un formulario. Las propiedades del tema controlan colores, tipografías, marca y diseño tanto del formulario en sí como de elementos individuales de la interfaz como botones, indicadores y opciones.
Todos los cuerpos de solicitud y respuesta utilizan nombres de campo en snake_case.
Obtener Tema del Formulario
/api/v1/forms/:id/themeObtiene todas las propiedades del tema de un formulario.
Parámetros de Ruta
idstringEl ID del formulario
Respuesta
{
"theme_color": "#6366f1",
"background_color": "#0a0a0a",
"text_color": "#ffffff",
"answer_text_color": "#e5e7eb",
"placeholder_color": "#6b7280",
"button_color": "#6366f1",
"button_text_color": "#ffffff",
"title_color": "#f9fafb",
"description_color": "#d1d5db",
"option_text_color": "#e5e7eb",
"indicator_bg_color": "#1f2937",
"indicator_text_color": "#9ca3af",
"font_family": "Inter",
"font_family_answer": "Inter",
"font_family_button": "Inter",
"font_family_description": "Inter",
"font_family_option": "Inter",
"font_family_indicator": "Inter",
"question_font_size": "24px",
"custom_css": null,
"show_progress_bar": true,
"branding_logo_url": null,
"branding_footer_text": null,
"hide_branding": false,
"top_logo_url": null,
"top_logo_size": null,
"top_logo_alignment": "center",
"top_logo_css": null,
"watermark_css": null,
"welcome_title": "Welcome",
"welcome_description": null,
"welcome_button_text": "Start",
"thank_you_title": "Thank you!",
"thank_you_description": null
}
Ejemplos de Código
curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
-H "Authorization: Bearer YOUR_API_KEY"
Actualizar Tema del Formulario
/api/v1/forms/:id/themeActualiza las propiedades del tema de un formulario. Solo incluye los campos que deseas cambiar. Los campos no especificados conservan sus valores actuales.
Parámetros de Ruta
idstringEl ID del formulario
Cuerpo de Solicitud
Incluye cualquier combinación de propiedades de tema de la Referencia de Propiedades de Tema a continuación.
Ejemplo de Solicitud
{
"theme_color": "#2563eb",
"background_color": "#ffffff",
"text_color": "#111827",
"button_color": "#2563eb",
"button_text_color": "#ffffff",
"font_family": "Poppins",
"question_font_size": "28px",
"show_progress_bar": true,
"hide_branding": true,
"top_logo_url": "https://cdn.example.com/logo.svg",
"top_logo_size": "140px",
"top_logo_alignment": "left"
}
Respuesta
Devuelve el objeto de tema completo y actualizado (mismo esquema que Obtener Tema del Formulario).
Ejemplos de Código
curl -X PUT "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"theme_color": "#2563eb",
"background_color": "#ffffff",
"text_color": "#111827",
"font_family": "Poppins"
}'
Referencia de Propiedades de Tema
A continuación se encuentra la lista completa de propiedades de tema disponibles para personalización.
Propiedades de Color
theme_colorstringColor de acento primario usado en todo el formulario (anillos de enfoque, resaltados). Por defecto: "#6366f1"
background_colorstringColor de fondo del formulario. Por defecto: "#0a0a0a"
text_colorstringColor de texto principal de la pregunta. Por defecto: null
answer_text_colorstringColor del texto escrito en los campos de respuesta. Por defecto: null
placeholder_colorstringColor del texto placeholder para campos vacíos. Por defecto: null
button_colorstringColor de fondo para botones de enviar/siguiente. Por defecto: null
button_text_colorstringColor del texto para botones de enviar/siguiente. Por defecto: null
title_colorstringColor del texto del título de la pregunta (anula text_color para títulos). Por defecto: null
description_colorstringColor del texto de la descripción de la pregunta. Por defecto: null
option_text_colorstringColor del texto para opciones de selección múltiple y desplegables. Por defecto: null
indicator_bg_colorstringColor de fondo para el indicador de número de paso/pregunta. Por defecto: null
indicator_text_colorstringColor del texto para el indicador de número de paso/pregunta. Por defecto: null
Propiedades de Tipografía
font_familystringFamilia tipográfica para títulos de preguntas. Soporta cualquier Google Font o fuente del sistema. Por defecto: null
font_family_answerstringFamilia tipográfica para texto de entrada de respuestas. Por defecto: null
font_family_buttonstringFamilia tipográfica para etiquetas de botones. Por defecto: null
font_family_descriptionstringFamilia tipográfica para descripciones de preguntas. Por defecto: null
font_family_optionstringFamilia tipográfica para etiquetas de opciones de selección múltiple. Por defecto: null
font_family_indicatorstringFamilia tipográfica para indicadores de número de paso/pregunta. Por defecto: null
question_font_sizestringTamaño de fuente para títulos de preguntas (ej., "24px", "1.5rem"). Por defecto: null
Diseño y Progreso
show_progress_barbooleanSi se muestra una barra de progreso en la parte superior del formulario. Por defecto: true
Marca
branding_logo_urlstringURL para un logo de marca mostrado en el área del pie de página. Por defecto: null
branding_footer_textstringTexto personalizado mostrado en el pie de página del formulario. Por defecto: null
hide_brandingbooleanOcultar el pie de página de marca predeterminado de NueForm. Por defecto: false
top_logo_urlstringURL para un logo mostrado en la parte superior del formulario. Por defecto: null
top_logo_sizestringTamaño del logo superior (ej., "120px", "80px"). Por defecto: null
top_logo_alignmentstringAlineación horizontal del logo superior: "left", "center", "right". Por defecto: null
top_logo_cssstringCSS personalizado aplicado al contenedor del logo superior. Por defecto: null
watermark_cssstringCSS personalizado aplicado a la marca de agua. Por defecto: null
Pantallas de Bienvenida y Agradecimiento
welcome_titlestringTexto del título mostrado en la pantalla de bienvenida. Por defecto: null
welcome_descriptionstringTexto de la descripción en la pantalla de bienvenida. Por defecto: null
welcome_button_textstringEtiqueta del botón en la pantalla de bienvenida. Por defecto: "Start"
thank_you_titlestringTexto del título en la pantalla de completitud. Por defecto: "Thank you!"
thank_you_descriptionstringTexto de la descripción en la pantalla de completitud. Por defecto: null
Avanzado
custom_cssstringCSS arbitrario inyectado en el renderizador del formulario. Úsalo para personalizaciones avanzadas que las propiedades de tema no cubren. Por defecto: null
Respuestas de Error
Respuestas de error estándar devueltas por estos endpoints.
Códigos de Error
401UnauthorizedAPI key faltante o inválida
403ForbiddenPermisos insuficientes para formularios de equipo
404Not FoundFormulario no encontrado
500Server ErrorError interno del servidor
Ejemplo de Error
{
"error": "Form not found"
}