TIBCO Cloud™ Mashery - Customization

By:
Last updated:
2:09pm May 14, 2020

Mashery is hosted by TIBCO and as such uses its domains. However, you can customize it to use your own domains:

  • Create CNAMEs.
  • Provide security certificates for those CNAMEs.
  • Configure a sender email address for notifications that Mashery sends.

Create CNAMEs

Your Mashery instance includes:

  • a Developer Portal hosted on a TIBCO-owned domain, e.g., eval19997006.mashery.com and
  • the API gateway, where your customers sent API requests, which is also hosted on a TIBCO-owned domain, e.g., eval19997006.api.mashery.com.

You or your DNS provider can create meaningful CNAMEs to these hosts so that you customers access Mashery using your own domain, e.g.,

  • CNAME developer.acme.com that points to the Developer Portal at eval19997006.mashery.com and
  • CNAME api.acme.com that points to API gateway e.g., eval19997006.api.mashery.com.

CNAME DNS TTL

When establishing your CNAME for the API gateway, consider its DNS TTL. The default gateway hostname (e.g., eval19997006.api.mashery.com) points to a load balancer in one of TIBCO's data centers. If that becomes unavailable, it will automatically transfer to another data center and thus the load balancer's IPs change. Your CNAME should now resolve to those IPs. You want to minimize the TTL of your CNAME DNS to avoid outages during a TIBCO data center failover. There might be cost implications to this, so check with your DNS provider to find a value that matches your business risk.

Here's an example:

nslookup eval19997006.api.mashery.com
Server:        10.106.136.20
Address:    10.106.136.20#53

Non-authoritative answer:
eval19997006.api.mashery.com    canonical name = mashery-tm-us-east-1.mashery.com.
mashery-tm-us-east-1.mashery.com    canonical name = mashery-tm-j-933123374.us-east-1.elb.amazonaws.com.
Name:    mashery-tm-j-933123374.us-east-1.elb.amazonaws.com
Address: 54.243.48.205
Name:    mashery-tm-j-933123374.us-east-1.elb.amazonaws.com
Address: 54.243.83.143
Name:    mashery-tm-j-933123374.us-east-1.elb.amazonaws.com
Address: 23.23.235.7

 

Your CNAME resolves to the IPs 54.243.48.205, 54.243.83.143 and 23.23.235.7, a load balancer in US East 1. If that data center fails, then TIBCO automatically repoints eval19997006.api.mashery.com to another data center, e.g. US West 1, and this will have different IPs. You need make sure your CNAME DNS TTL updates in good time to pick-up those new IPs. Take into account that the TTL for *.mashery.com is 60 seconds.

Security certificates

If you wish to use HTTPS for API requests or to access the Developer Portal, then purchase certificates for your CNAMEs. Raise a support request for TIBCO to install these. TIBCO requires both the public and private keys to host your certificates.

Configure a sender email address

Mashery sends emails for various events, e.g., member registration on the Developer Portal. The sender of these emails has a TIBCO-owned address, e.g., noreply@mashery.com.

If you want Mashery to use an email address that you own, e.g., api-noreply@acme.com, then please raise a support request. Note, you will need access to your mailbox to approve a validation request sent from TIBCO's Amazon SES. Once configured, set your new email address using the API Control Center.

Attachments

AttachmentSize
PDF icon mashery_-_configure_email_addresses.pdf207.98 KB