Custom Domain

SaaS
To complete the branding of your Developer Portal, you’ll probably want to have it appear under your own corporate domain name at a location like https://developer.mydomain.com or https://api.mydomain.com. The most popular option among 3scale customers is developer.mydomain.com.

This process involves several approval steps, so please allow plenty of time (we recommend 2 weeks) to initiate the change before you need it to be done.

At the end of this tutorial, you’ll have changed the URL of your Developer Portal to a new location under your own company domain name.

Step 1: Add a CNAME entry to your DNS setup

Configure your own DNS records to point to the location of 3scale’s servers. You need to implement the CNAME through your DNS provider.

CNAME developer.mydomain.com pointing to mydomain.3scale.net

Normally you would want to make the change to your custom domain before you allow public access to your Developer Portal. If you already have public users, bear in mind that it’s not possible to define a redirect from mydomain.3scale.net to your custom domain, so you’ll need to inform your users about the domain change.

It’s best to implement the CNAME in advance. In the rare case that this isn’t possible – such as if you have an existing site in public use at that domain – please contact 3scale support to determine the best way to synchronize a switchover.

Step 2: Request the domain change and SSL certificate from 3scale

All Developer Portals run under SSL. When changing to your own domain, you’ll need to enable an SSL certificate for your domain. Inform 3scale with the following information:

  1. Your company name
  2. The domain name you would like to activate such as developer.yourdomain.com (this needs to be a domain within your control)

3scale will confirm the domain name procedure and initiate the creation of an SSL certificate using DigiCert. DigiCert will send an email to the registered contact owner of your domain requesting approval of the creation of an SSL certificate for the subdomain. The person in question – either a named person in your organization or a generic address such as postmaster@yourdomain.com – will need to approve it.

Before initiating the process, it’s important to inform the individual who will receive the email that this is happening.

Once the certificate is approved, it will be issued to cover the Developer Portal. 3scale will confirm once this has been done.

Step 3: Approve the SSL certificate to be issued

Within one week (maximum) after receiving the SSL certificate approval, 3scale will complete the domain change in our systems and inform you.

Step 4: Wait for the DNS configuration to propagate

The DNS records need to propagate before users will be able to associate the new location with this address. This usually takes about 30 minutes, but can take up to 24 hours. If it takes longer than this, check that the record has been correctly associated with the domain. You can do this by using a tool such as nslookup or dig on the subdomain.

Step 5: Final cleanup

Review and test your Developer Portal carefully after the domain change. In particular, any links to the custom domain that are not relative must be updated.