Modulaire white-label architectuur
Passinstance biedt white-label branding aan als modulaire mogelijkheden die worden beheerd via White-Label Domains API (/api/v1/white-labeling/* en in het Dashboard onder Werkruimte-instellingen -> Branding /settings/workspace/branding plus Berichten -> SMTP /settings/workspace/messaging/smtp). Organisaties en bureaus kunnen per werkruimte drie afzonderlijke contactpunten aanpassen:
-
1
Vanity-domeinen voor passen en portalen (domain surface type): Serveer slimme distributielinks (
/d/:slug,/s/:token), PassFlow-inschrijfpagina's, de backoffice-UI, workflowportalen, documentatie of ondersteuningsportalen vanaf uw eigen subdomein (wallet.yourbrand.com) met geautomatiseerde TLS-beëindiging. -
2
Transactionele e-mail in eigen huisstijl: Verstuur e-mails voor pasdistributie en -herstel vanaf uw eigen domein met geverifieerde SPF- en DKIM-handtekeningen (
request payload). -
3
Thema-instellingen voor portaal en console (
request payload): Pas kleurenschema's, donkere/lichte logo's, favicons enpoweredByEnabled-instellingen aan.
White-labeling API-referentie (White-Label Domains API)
Alle eindpunten voor white-label configuratie zijn gekoppeld aan de actieve tenantwerkruimte:
| Eindpuntpad | Methode | Auth | Functionaliteit |
|---|---|---|---|
/api/v1/white-labeling/configuration | GET | Bearer (whitelabel:view) | Haalt de volledige brandingconfiguratie van de werkruimte op. |
/api/v1/white-labeling/features | GET | Bearer (whitelabel:view) | Retourneert welke white-label add-on-mogelijkheden zijn ontgrendeld in het abonnement van de werkruimte. |
/api/v1/white-labeling/vanity-urls | GET | Bearer (whitelabel:manage) | Toont geconfigureerde vanity-domeinen en hun DNS-/SSL-status. |
/api/v1/white-labeling/vanity-urls | POST | Bearer (whitelabel:manage) | Registreert een nieuw vanity-domein (request payload) en genereert DNS-verificatietokens. |
/api/v1/white-labeling/vanity-urls/:id | DELETE | Bearer (whitelabel:manage) | Verwijdert een vanity-domein en zet slimme links terug naar de standaard platformroutering. |
/api/v1/white-labeling/domains/:id/refresh | POST | Bearer | Activeert een onmiddellijke DNS-lookup voor CNAME- en TXT-records. |
/api/v1/white-labeling/domains/:id/certificate-ready | POST | Bearer | Bevestigt de uitgifte van het SSL/TLS-certificaat en activeert HTTPS-verkeersbeëindiging. |
/api/v1/white-labeling/email | GET / POST / DELETE | Bearer | Leest, maakt aan (request payload) of verwijdert instellingen voor e-mailafzenders in eigen huisstijl en SPF/DKIM-records. |
/api/v1/white-labeling/email/refresh | POST | Bearer | Controleert live DNS-records opnieuw op SPF-uitlijning en doorgifte van de DKIM-selector. |
/api/v1/white-labeling/email/verify | POST | Bearer | Bevestigt het domeinverificatietoken en promoveert de afzender naar de actieve status. |
/api/v1/white-labeling/theme | GET / PUT / DELETE | Bearer | Leest, wijzigt (request payload) of herstelt portaalkleuren en logo's. |
Een vanity-downloaddomein configureren (request payload & domain surface type)
Stap 1: Registreer de hostnaam en het doeloppervlak
Stuur een POST /api/v1/white-labeling/vanity-urls-verzoek met opgave van de FQDN url, het type uit domain surface type (PASS_DOWNLOAD, PASS_FLOW, BACKEND_UI, WORKFLOW_ENGINE, API_DOCUMENTATION, SUPPORT_PORTAL), een optionele homePageRedirect en isPrimary:
{
"url": "wallet.yourbrand.com",
"type": "PASS_DOWNLOAD",
"homePageRedirect": "https://www.yourbrand.com/wallet",
"isPrimary": true
}
Antwoord (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"
}
Stap 2: Configureer DNS en vernieuw
Voeg bij uw DNS-provider het vereiste CNAME-record toe dat verwijst naar cname.passinstance.com, evenals het TXT-verificatierecord. Zodra deze zijn doorgevoerd, roept u POST /api/v1/white-labeling/domains/:id/refresh aan, gevolgd door POST /api/v1/white-labeling/domains/:id/certificate-ready om de TLS-inrichting te voltooien.
E-mailbezorging in eigen huisstijl en portaalthema's configureren
Om e-mails voor pasuitgifte en -herstel vanaf uw eigen domein te verzenden, registreert u uw afzenderidentiteit ({ senderEmail, senderName?, spfRecord?, dkimRecord?, dkimSelector? }) via POST /api/v1/white-labeling/email en valideert u de SPF/DKIM-uitlijning met POST /api/v1/white-labeling/email/refresh en POST /api/v1/white-labeling/email/verify.
Om uw klantgerichte distributiepagina's vorm te geven, werkt u het thema bij via PUT /api/v1/white-labeling/theme met behulp van 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
}
}
Vereisten: Wanneer u een vanity-domein configureert in Cloudflare of vergelijkbare proxynetwerken, stelt u het CNAME-record tijdens de eerste verificatie in op DNS Only (grijze wolk), zodat Passinstance het doelrecord
cname.passinstance.comkan valideren en uw beheerde TLS-certificaat zonder proxy-interferentie kan inrichten.
Bekijk de volledige architectuurdetails op de pagina White-Label Wallet Pass API of beheer add-on-abonnementen onder Prijzen.
