Branded Domains
Overview
When integrated with VGS, by default, the traffic is passed via VGS proxy, which looks like either tntdcjppp6x.sandbox.verygoodproxy.com or tntdcjppp6x.live.verygoodproxy.com, where tntdcjppp6x is your vault identifier. Branded Domains allow VGS customers to publish public APIs that utilize their self-maintained domain names but are protected by VGS. Any request to a branded domain will be proxied through the Inbound Route to which it is connected based on the customer-defined VGS configuration.
Terms
CNAME: a canonical name, an entry within the Domain Name System (DNS) that specifies where someone can find your web pages.
Default hostname: VGS term for the default domain with the form {{environment}}.verygoodsecurity.com
Domain alias: term for additional branded domains assigned to a site.
DNS provider: a company that maintains the DNS servers that translate a domain name to a destination.
TLS certificate: TLS stands for Transport Layer Security, together with the now-deprecated predecessor, Secure Sockets Layer (SSL), are cryptographic protocols designed to provide communications security over a computer network.
Add a Branded Domain
Add a new CNAME and a TLS certificate will be issued for it by VGS.
Dedicated TLS certificates are automatically generated and propagated through our global content delivery network, providing robust encryption, along with lightning-fast performance and compatibility.
Add a custom Hostname on the dashboard:
Log in to the VGS dashboard.
Go to the Vault Settings > Custom Hostnames
Click Add
Enter the domain alias (CNAME domain). For example payments.brandeddomain.com
Click Save
The validation and deployment process completes in ~90 seconds. After adding the Branded Domain, view the provisioning status under the Status column in the CNAMEs section. The provisioning takes up to 30 minutes. VGS defaults to auto-renewal of the TLS certificate.
If the provisioning was successful - you will see "Activate for SDKs" button. Verifying allows you to use this CNAME with VGS Collect/Show/Checkout products.
If the hostname is invalid:
Visit your DNS provider
Add a CNAME record for mydomain pointing to either <vault_id>.sandbox.verygoodproxy.com or <vault_id>.live.verygoodproxy.com
If you’ve already done this, allow up to 24 hours for the changes to propagate. Once issued, certificates are valid for 90 days, and renew automatically 21 days before expiration. Renewals require no action from your side.
Connect a Branded Domain to an Inbound Route
To assign a branded domain to an inbound route:
Go to Routes › click Manage
Click on the + icon in the Custom Hostnames section
Select a custom hostname from the list or add a new CNAME
Save the route
The Default CNAME is the VGS hostname used by your service/s. The default CNAME can be used only once. To change it, choose one of the CNAMEs from the list and then remove the default one.
Removing a CNAME
Go to the Vault Settings > Custom Hostnames
Press the ‘delete’ icon next to the custom hostname that needs to be removed.
CNAMEs Errors
In case your CNAME becomes invalid. If, for instance, the CNAME value points to the incorrect domain, the status field on the Custom Hostnames tab changes from ‘Valid’ to ‘Invalid’.
Last updated