zimki | documentation | search
 
Zimki Documentation - CookBook.CustomURL

By default the URL to your realm contains a UUID, which is both ugly looking and fairly hard to remember. The good news is that it is guaranteed to be unique, and that you can change it.

We will allow you to bind a custom domain to your realm in the future, but in the meantime you can create an alias for the API key used to identify your realm. This means you can access your realm by visiting

http://services.zimki.com/u/madam-x

if you wish. To create an alias for an API key, browse to the API Keys link in the REALMS section of the portal. pick an active API key and click the edit link. Edit the text box labelled Alias and click the edit button. Remember that aliases has to be unique across all realms, including the ones you don't own, so you might not always be able to get your first choice. You can add several API keys with different aliases if you want.

Multiple aliases

Your realm contains all the data, files and JavaScript for your application or set of applications you build. Access to your realm is controlled through an API key, which keeps track of things such as how much traffic goes to your realm etc.

You can create multiple API keys and therefore create multiple access points to your realm, each one with a different URL.

Why would you do this? Well for example suppose I built a killer web site, I might want to provide it to different customers and keep track of their usage. Hence I might want to give them different URLs. You can access the API key information from JavaScript space if you want to customise the realm based on the url used for accessing it.

See also

  • zimki.root returns the path used to access the site
  • zimki.apikey returns the api key used to access the site
  • zimki.alias returns the current alias used to access the site

Parent

CookBook