FAQs – MDS Foundation Map

The MDS Foundation Map has recently been upgraded to provide a faster and more dynamic user experience. The following page contains frequently asked questions regarding technical issues and specifications.

If you are experiencing difficulty or have any questions regarding the MDS Foundation Map, please contact our Client Services team on +61 2 8436 2800.

 

What security is in place to access the MDS Foundation Map?

In terms of security, the MDS Foundation Map APIs use API key and basic access authentication (please see the specific service documentation for detailed information).

  • API key
    This mode requires the API key to be provided in the query string of each request. This mode is preferred when making service calls from web browsers application.
  • Basic authentication
    This mode means that each request that is made to the service must include the authorisation header. This mode is preferred when making service calls from either mobile or desktop applications.

What is the Uniform Resource Identifier (URI) I'll be using for development and why do I have to register it?

The URI is used for your protection. It's to prevent others from using your key on another site and using all your allotted transactions (possibly resulting in a bill, or having your key stop working). Our servers will know and recognise your registration key and check to ensure the request is coming from the URI that you register. If the key and URI do not match, then our servers will reject the request.


How do the servers use the URI?

Our servers will look to see if your request comes from the exact URI you registered or any URI under that. For example, registering “http://www.yourdomain.com/mydev” will allow our servers to recognise URIs such as:

  • http://www.yourdomain.com/mydev/mymap.html”
  • http://www.yourdomain.com/mydev/project1/mymap.html”
  • http://www.yourdomain.com/mydev/project2/mymap.html”

The servers will not recognise:

  • http://www.yourdomain.com/mymap.html” - comes a level above the registered URI
  • http://yourdomain.com/mydev/mymap.html” - is a totally different URI (not www)
  • http://dev.yourdomain.com/mydev/mymap.html” - is also a totally different URI (dev)
  • http://www.yourdomain.com:8080/mydev/mymap.html” - treated as a different URI. In this instance registering "http://www.yourdomain.com" (without an end slash) will allow the use of the port number as coming under the base URI.

To allow you to develop under different URIs for legitimate reasons (e.g. both with and without the "www"), we allow you to register more than one URI.


What is a "valid URI"?

A valid URI must be prefixed by "http://" or "https://".

It is advisable to just enter the URI for your domain e.g. “http://yourdomain.com”. This will work for all ports “http://yourdomain.com:8080” and subdirectories “http://yourdomain.com/yourapp/” on this domain. To enable subdomains such as “http://www.yourdomain.com”, or “http://dev.yourdomain.com”, we recommend you add these as separate URIs.

Tips:

  • We accept both HTTP and HTTPS schemes, but these must be detailed in separate URIs if you wish to use both schemes.
  • When entering a URI for your domain, we recommend you do not add a trailing slash, as adding this prohibits us from matching on port numbers.
  • We also accept valid complete IP addresses as URIs e.g. “http://127.0.0.1”
  • If you enter a URI with a subdirectory e.g. “http://yourdomain.com/yourapp/” we will be unable to match on any port numbers e.g. “http://yourdomain.com:44633/yourapp/”

Can I register using my localhost?

Yes, but be aware of the security implications of registering localhost. Using localhost will allow you to develop on your own computer with just an internet connection to download the map tiles and other transactions from our servers.

Registering “http://localhost”, “http://127.0.0.1”, or even “http://mymachinename” is all valid so long as it is precluded by either http:// or https://, however, this can cause some issues if others obtain your registered key.

Everyone who registers “http://localhost” will be given a unique key and that key is then tied to their development account. Our servers only check to see if the base URI is what you have registered and has no way of telling if that is you or someone else using your key on their computer.

Giving a genuine development URI protects you as no one else should have access to your development area and the key would then be of no use to anyone else as it will only work on that URI.


How do I change my URI; disassociate a key; or add another URI to the key?

Your key may have become compromised; someone else may have your localhost key; your server name has been changed; the IT department has decided to move all development onto another server.

Whatever the reason, occasionally you might want to change the URI or even have a new key issued for the same URI. Maybe you want your old key stopped. How do you go about that? Contact our Client Services team on +61 2 8436 2800.