This guide includes the following sections:
API Key authentication allows you to consume Nearmap imagery in an application without having to provide your Nearmap username and password as authentication credentials. Instead you include an API Key – a unique long string associated with a particular user on your Nearmap account – and then include that API Key in all requests to Nearmap endpoints, typically by appending it to a URL.
In addition to this guide, you can view our Service Portal tutorial video on How to Generate API Keys.
You manage API Keys using a simple user interface within your Nearmap profile; no API call is needed to create an API Key. An API Key is valid until you delete it; you do not have to regularly refresh it.
API Key authentication works for both desktop applications and custom web applications. If your application supports using map content via any of the supported Nearmap interfaces, including WMS, TMS and Image API, you should be able to integrate Nearmap imagery with minimal configuration using an API Key.
You can configure an API Key so that it can only be used from a restricted set of IP addresses or applications. See Creating and managing an API Application below for details.
By design, you cannot use an API Key to log in to the Nearmap MapBrowser web application. Use your Nearmap username and password to log in to MAPBROWSER.
There are two key components to Nearmap API Key authentication:
Note: There is a character limit of 1 to 100 characters for the referrer restrictions.
Your API Application should be displayed on the screen. Each user on your Nearmap account can now create an API Key for that API Application.
As a Nearmap administrator, you can also use the API Access tab to:
Once an administrator has created an API Application, you can log in to Nearmap to create an API Key for that application.
The API Key is now created – it is the long string of characters in the API Key column. You can use it in your integrations, as explained in Using an API Key in Nearmap Integrations.
If you no longer need an existing API Key, you can log in to Nearmap to delete it.