State departments often collaborate with counties and local municipal councils to coordinate disaster response. As a Nearmap user in a state department, you can now share Nearmap ImpactResponse imagery and related data with local entities through API keys. For this purpose, two types of API keys can be created:
- Permanent keys: These can be used for the life of your ImpactResponse subscription unless manually deactivated.
- Temporary keys: These are intended for sharing with local government entities impacted by a specific catastrophic event, and must be deactivated after 30 days.
Key Type | Purpose and Usage Guidelines | Lifespan | Termination Rule |
|---|
Permanent | Use only for internal disaster-related workflows. Do not share with external parties. | Subscription | Manual deactivation |
Temporary Shared | Use for collaboration with local government. Only share with authorized local government partners. Monitor usage and revoke access immediately if misuse is suspected. | 30 days | Must deactivate after 30 days |
Creating and managing API keys
You can create and manage API keys in MyAccount. For instructions on creating an API key, refer to the article - Create an API Key.
Given below are some tips for naming your API keys to help you easily differentiate between permanent and temporary API keys.
Naming convention for API keys
To ensure clarity and traceability, use the following elements to name your API keys:
DisasterType: Use this for the event (Hurricane, Wildfire, Tornado, etc.) EventName: Use a specific identifier for the event such as its name (e.g., Ida, Milton, CampFire). StartDate: Use the date when the key is created, or the event starts (YYYYMMDD format).
Examples
Key Type | Naming Example |
|---|
Permanent | TX_Hurricane_Beryl_Permanent QLD_Cyclone_Alfred_Permanent |
Temporary Shared | CA_Wildfire_Palisades_20250107_Shared VIC_Bushfire_Grampians_20240212_Shared |
Security best practices
- Never embed API keys in client-side code or public repositories.
- Rotate keys periodically and after any security incident.