Arquitectura Modular de Marca Blanca
Passinstance ofrece personalización de marca blanca mediante capacidades modulares gestionadas a través de White-Label Domains API (/api/v1/white-labeling/* y en el Panel en Configuración del Espacio de Trabajo -> Marca /settings/workspace/branding además de Mensajería -> SMTP /settings/workspace/messaging/smtp). Las organizaciones y agencias pueden personalizar tres puntos de contacto distintos por espacio de trabajo:
-
1
Dominios Personalizados de Pases y Portales (domain surface type): Sirva enlaces de distribución inteligente (
/d/:slug,/s/:token), páginas de inscripción de PassFlow, interfaz administrativa, portales de flujos de trabajo, documentación o portales de soporte desde su propio subdominio (wallet.yourbrand.com) con terminación TLS automatizada. -
2
Correo Electrónico Transaccional con Marca: Entregue correos electrónicos de distribución y recuperación de pases desde su propio dominio con firmas SPF y DKIM verificadas (
request payload). -
3
Temas del Portal y de la Consola (
request payload): Personalice esquemas de colores, logotipos para modo claro/oscuro, favicons y los ajustes depoweredByEnabled.
Referencia de la API de Marca Blanca (White-Label Domains API)
Todos los endpoints de configuración de marca blanca están delimitados al espacio de trabajo activo del inquilino:
| Ruta del Endpoint | Método | Autenticación | Funcionalidad |
|---|---|---|---|
/api/v1/white-labeling/configuration | GET | Bearer (whitelabel:view) | Recupera la configuración completa de marca del espacio de trabajo. |
/api/v1/white-labeling/features | GET | Bearer (whitelabel:view) | Devuelve qué capacidades adicionales de marca blanca están desbloqueadas en el plan del espacio de trabajo. |
/api/v1/white-labeling/vanity-urls | GET | Bearer (whitelabel:manage) | Lista los dominios personalizados configurados y su estado de DNS/SSL. |
/api/v1/white-labeling/vanity-urls | POST | Bearer (whitelabel:manage) | Registra un nuevo dominio personalizado (request payload) y genera tokens de verificación DNS. |
/api/v1/white-labeling/vanity-urls/:id | DELETE | Bearer (whitelabel:manage) | Elimina un dominio personalizado y revierte los enlaces inteligentes al enrutamiento predeterminado de la plataforma. |
/api/v1/white-labeling/domains/:id/refresh | POST | Bearer | Activa la búsqueda DNS inmediata para los registros CNAME y TXT. |
/api/v1/white-labeling/domains/:id/certificate-ready | POST | Bearer | Confirma la emisión del certificado SSL/TLS y activa la terminación de tráfico HTTPS. |
/api/v1/white-labeling/email | GET / POST / DELETE | Bearer | Lee, crea (request payload) o elimina ajustes de remitente de correo con marca y registros SPF/DKIM. |
/api/v1/white-labeling/email/refresh | POST | Bearer | Vuelve a comprobar los registros DNS en vivo para la alineación SPF y la propagación del selector DKIM. |
/api/v1/white-labeling/email/verify | POST | Bearer | Confirma el token de verificación del dominio y promueve el remitente al estado activo. |
/api/v1/white-labeling/theme | GET / PUT / DELETE | Bearer | Lee, actualiza (request payload) o restablece los colores y logotipos del portal. |
Configuración de un Dominio Personalizado de Descarga (request payload y domain surface type)
Paso 1: Registrar el Nombre de Host y la Superficie de Destino
Envíe una solicitud POST /api/v1/white-labeling/vanity-urls especificando la url FQDN, el type de domain surface type (PASS_DOWNLOAD, PASS_FLOW, BACKEND_UI, WORKFLOW_ENGINE, API_DOCUMENTATION, SUPPORT_PORTAL), el homePageRedirect opcional e isPrimary:
{
"url": "wallet.yourbrand.com",
"type": "PASS_DOWNLOAD",
"homePageRedirect": "https://www.yourbrand.com/wallet",
"isPrimary": true
}
Respuesta (201 Created):
{
"id": "dom_94a1c02b",
"url": "wallet.yourbrand.com",
"type": "PASS_DOWNLOAD",
"status": "PENDING_DNS",
"cnameTarget": "cname.passinstance.com",
"txtRecordName": "_passinstance-verify.wallet.yourbrand.com",
"txtRecordValue": "pi-verify=7f8e9a10b2c3d4e5f6",
"sslStatus": "PENDING"
}
Paso 2: Configurar DNS y Actualizar
Añada el registro CNAME requerido que apunte a cname.passinstance.com y el registro TXT de verificación en su proveedor de DNS. Una vez propagados, active POST /api/v1/white-labeling/domains/:id/refresh seguido de POST /api/v1/white-labeling/domains/:id/certificate-ready para finalizar el aprovisionamiento de TLS.
Configuración de Entrega de Correo con Marca y Temas del Portal
Para enviar correos electrónicos de emisión y recuperación de pases desde su propio dominio, registre su identidad de remitente ({ senderEmail, senderName?, spfRecord?, dkimRecord?, dkimSelector? }) mediante POST /api/v1/white-labeling/email y valide la alineación SPF/DKIM utilizando POST /api/v1/white-labeling/email/refresh y POST /api/v1/white-labeling/email/verify.
Para personalizar el estilo de sus páginas de distribución orientadas al cliente, actualice el tema mediante PUT /api/v1/white-labeling/theme utilizando request payload:
{
"logoUrl": "https://cdn.yourbrand.com/assets/logo.png",
"logoLightUrl": "https://cdn.yourbrand.com/assets/logo-light.png",
"logoDarkUrl": "https://cdn.yourbrand.com/assets/logo-dark.png",
"faviconUrl": "https://cdn.yourbrand.com/assets/favicon.ico",
"colorScheme": {
"primary": "#0F172A",
"secondary": "#2563EB",
"background": "#F8FAFC",
"text": "#020617",
"appName": "YourBrand Wallet",
"poweredByEnabled": false
}
}
Requisitos previos: Al configurar un dominio personalizado en Cloudflare o redes proxy similares, establezca el registro CNAME en Solo DNS (nube gris) durante la verificación inicial para que Passinstance pueda validar el registro
cname.passinstance.comde destino y aprovisionar su certificado TLS gestionado sin interferencias del proxy.
Explore todos los detalles arquitectónicos en la página API de Pases de Billetera de Marca Blanca o gestione las suscripciones de complementos en Precios.
