Architecture modulaire en marque blanche
Passinstance propose la personnalisation en marque blanche sous forme de fonctionnalités modulaires gérées via White-Label Domains API (/api/v1/white-labeling/* et dans le tableau de bord sous Workspace Settings -> Branding /settings/workspace/branding ainsi que Messaging -> SMTP /settings/workspace/messaging/smtp). Les organisations et les agences peuvent personnaliser trois points de contact distincts par espace de travail :
-
1
Domaines personnalisés de passes et de portails (domain surface type) : Servez les liens de distribution intelligents (
/d/:slug,/s/:token), les pages d'inscription PassFlow, l'interface back-office, les portails de workflows, la documentation ou les portails de support depuis votre propre sous-domaine (wallet.yourbrand.com) avec terminaison TLS automatisée. -
2
E-mails transactionnels à votre marque : Envoyez les e-mails de distribution et de récupération de passes depuis votre domaine avec des signatures SPF et DKIM vérifiées (
request payload). -
3
Thème du portail et de la console (
request payload) : Personnalisez les palettes de couleurs, les logos clair/sombre, les favicons et le paramètrepoweredByEnabled.
Référence de l'API de marque blanche (White-Label Domains API)
Tous les points de terminaison de configuration en marque blanche sont rattachés à l'espace de travail locataire actif :
| Chemin du point de terminaison | Méthode | Auth | Fonctionnalité |
|---|---|---|---|
/api/v1/white-labeling/configuration | GET | Bearer (whitelabel:view) | Récupère la configuration complète de marque de l'espace de travail. |
/api/v1/white-labeling/features | GET | Bearer (whitelabel:view) | Renvoie les options de marque blanche débloquées sur le forfait de l'espace de travail. |
/api/v1/white-labeling/vanity-urls | GET | Bearer (whitelabel:manage) | Liste les domaines personnalisés configurés ainsi que leur statut DNS/SSL. |
/api/v1/white-labeling/vanity-urls | POST | Bearer (whitelabel:manage) | Enregistre un nouveau domaine personnalisé (request payload) et génère les jetons de vérification DNS. |
/api/v1/white-labeling/vanity-urls/:id | DELETE | Bearer (whitelabel:manage) | Supprime un domaine personnalisé et rétablit le routage par défaut de la plateforme pour les liens intelligents. |
/api/v1/white-labeling/domains/:id/refresh | POST | Bearer | Déclenche une vérification DNS immédiate des enregistrements CNAME et TXT. |
/api/v1/white-labeling/domains/:id/certificate-ready | POST | Bearer | Confirme l'émission du certificat SSL/TLS et active la terminaison du trafic HTTPS. |
/api/v1/white-labeling/email | GET / POST / DELETE | Bearer | Lit, crée (request payload) ou supprime les paramètres d'expéditeur d'e-mail personnalisé et les enregistrements SPF/DKIM. |
/api/v1/white-labeling/email/refresh | POST | Bearer | Revérifie les enregistrements DNS en direct pour l'alignement SPF et la propagation du sélecteur DKIM. |
/api/v1/white-labeling/email/verify | POST | Bearer | Confirme le jeton de vérification du domaine et passe l'expéditeur au statut actif. |
/api/v1/white-labeling/theme | GET / PUT / DELETE | Bearer | Lit, met à jour (request payload) ou réinitialise les couleurs et logos du portail. |
Configuration d'un domaine de téléchargement personnalisé (request payload & domain surface type)
Étape 1 : Enregistrer le nom d'hôte et la surface cible
Envoyez une requête POST /api/v1/white-labeling/vanity-urls spécifiant le FQDN url, le type issu de domain surface type (PASS_DOWNLOAD, PASS_FLOW, BACKEND_UI, WORKFLOW_ENGINE, API_DOCUMENTATION, SUPPORT_PORTAL), le paramètre facultatif homePageRedirect ainsi que isPrimary :
{
"url": "wallet.yourbrand.com",
"type": "PASS_DOWNLOAD",
"homePageRedirect": "https://www.yourbrand.com/wallet",
"isPrimary": true
}
Réponse (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"
}
Étape 2 : Configurer le DNS et actualiser
Ajoutez l'enregistrement CNAME requis pointant vers cname.passinstance.com ainsi que l'enregistrement TXT de vérification chez votre fournisseur DNS. Une fois propagés, déclenchez POST /api/v1/white-labeling/domains/:id/refresh suivi de POST /api/v1/white-labeling/domains/:id/certificate-ready pour finaliser le provisionnement TLS.
Configuration de l'envoi d'e-mails à votre marque et des thèmes du portail
Pour envoyer les e-mails d'émission et de récupération de passes depuis votre propre domaine, enregistrez votre identité d'expéditeur ({ senderEmail, senderName?, spfRecord?, dkimRecord?, dkimSelector? }) via POST /api/v1/white-labeling/email et validez l'alignement SPF/DKIM à l'aide de POST /api/v1/white-labeling/email/refresh et POST /api/v1/white-labeling/email/verify.
Pour personnaliser le style de vos pages de distribution destinées aux clients, mettez à jour le thème via PUT /api/v1/white-labeling/theme en utilisant 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
}
}
Prérequis : Lors de la configuration d'un domaine personnalisé dans Cloudflare ou des réseaux proxy similaires, réglez l'enregistrement CNAME sur DNS uniquement (nuage gris) pendant la vérification initiale afin que Passinstance puisse valider l'enregistrement cible
cname.passinstance.comet provisionner votre certificat TLS géré sans interférence du proxy.
Explorez tous les détails d'architecture sur la page API de passes de portefeuille en marque blanche ou gérez vos abonnements aux options complémentaires sous Tarification.
