Advantages of API Key Authentication

API Key authentication has the following advantages over providing username and password when integrating with Nearmap imagery:

  • More secure: some existing applications do not provide a means of passing through username and password in a secure manner. API Key authentication is a more secure approach than using HTTP Basic Authentication or appending username and password directly to a URL.
  • More integrations possible: some existing applications do not provide a means of passing through username and password at all, and as such have not been able to consume Nearmap imagery. Many of those applications will work with an API Key.
  • Simpler: for customer applications, API Key authentication is a simpler approach than programmatically generating an access ticket that has to be periodically refreshed or programmatically revoked. Using an API Key may eliminate the need for any server-side programming for simple web applications.

Common Usage Scenarios

API Applications and API Keys together provide a flexible means of organising your Nearmap integrations. Here are some common usage scenarios:

  • Existing GIS application (e.g. Esri ArcGIS for Desktop): you could have one API Application for all your GIS applications, or alternatively one for each application, if they had different access restrictions. Each user of the GIS application may use their their own distinct API Key.
  • Custom web application: you could have just a single API Application, or alternatively you could have separate API Applications for your different hosting environments – for example, development, staging, production. All usage of Nearmap imagery is via one single API Key. Commonly you would create a separate Nearmap user that only consumed imagery via that API Key.

Support for Legacy Authentication Methods

We no longer provide support for integrations using legacy authentication mechanisms:

  • Ticket-based authentication
  • HTTP Basic authentication
  • Username and password in a URL