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.
About API Keys
Manage API keys using the simple interface in MyAccount; an API call is not required to create an API key.
An API key is valid until you delete it. However, it may need to be updated periodically. Hover over the API key name to check its expiry date and refresh your key when it reaches the expiry date.
API key authentication works for both desktop and custom web applications. If your application supports using map content via any of the supported Nearmap interface, such as WMS, TMS and Image API, you should be able to integrate Nearmap imagery with minimal configuration.
You can configure an API key so that it can only be used from a restricted set of IP addresses or applications. See Manage API Applications for details.
By design, you cannot use an API key to log into Nearmap MapBrowser and MyAccount. You must use your Nearmap user name and password to log into these applications.
Organizing your integrations
There are two key components to Nearmap API Key authentication:
- API Applications allow you to organize your Nearmap integrations, and to set different access restrictions for different integrations. You can have as many API Applications as you need on your Nearmap account. You must be a Nearmap administrator to create and manage API Applications.
- Every user on a Nearmap account can create one API Key for each API Application on that account. Usage accrued by an integration that uses an API Key will be a recorded against the user who owns that API Key.