Contrato de deep link
Las URLs del visualizador público y de embeds soportan cuatro parámetros estables de query que preseleccionan opciones de techo antes de que el propietario interactúe con el visualizador.Reglas de resolución
- Los nombres de parámetros van en minúsculas.
- Los valores se recortan y se comparan exactamente.
- Los valores vacíos se ignoran.
- Los parámetros repetidos usan el primer valor no vacío.
- brand se resuelve antes que material, shape y color.
- brand debe estar habilitado para el workspace y activo para el roofer; los valores de brand inválidos vuelven al catálogo de RoofKit.
- Un material inválido descarta shape y color.
- Una forma inválida o incompatible descarta color.
- Un color inválido descarta solo color.
- Las selecciones de shingle no requieren shape; cualquier valor de shape enviado se ignora para shingles.
- Los parámetros inválidos nunca muestran errores al propietario.
Ejemplos
Visualizador independiente
Visualizador específico de landing
Página host del widget de botón
Página host de la instalación inline
URL directa del embed
Landing con dominio personalizado
Notas de implementación
Para el widget de botón y el script inline de una línea, agrega los parámetros de deep link a la URL de la página host del contratista. RoofKit reenvía esos parámetros al iframe. Una URL directa de embed sigue aceptando los mismos parámetros.Fuente de verdad del catálogoLos valores válidos deben venir del catálogo público activo para el workspace y el roofer. Al usar brand, confirma que la biblioteca de colores esté habilitada para el workspace y activa para el roofer.