Skip to main content

API Keys

API keys connect the platform to external services for 3D terrain, location search, and Google 3D Tiles. Without the correct keys, those features are unavailable.

How keys are stored​

Keys are stored encrypted and are never displayed in full after saving. The UI shows only whether a key is currently set. To update a key, enter a new value and save; to remove a key, click Delete.

Key levels​

There are two levels at which API keys can be set:

LevelWhere to set itWho can edit
PersonalYour profile pageYou (your account only)
OrganisationOrganisation settings pageOrganisation owners and admins

Personal keys take priority over organisation-level keys for your own session. If no personal key is set, the organisation key is used as the fallback.

Key types​

Cesium Ion token​

Enables Cesium Ion assets, which include:

  • 3D terrain (elevation models for realistic topography)
  • OSM Buildings (3D city building models)
  • Cesium's default satellite imagery

These features are unavailable without a valid token.

Obtain a token from ion.cesium.com.

Google Maps API key​

Enables Google-powered features:

  • Location search bar — search for named places to fly the camera to
  • Google 3D Tiles — add Google's photorealistic 3D tiles as a project layer

Obtain a key from the Google Cloud Console. Enable the Geocoding API for location search and the Map Tiles API for Google 3D Tiles.

warning

Google 3D Tiles will not load unless the configured key has the Map Tiles API enabled. Usage may be billed by Google according to your Google Cloud account settings.

Setting a personal API key​

  1. Open your profile page.
  2. Scroll to the API Keys section.
  3. Click the field for the key you want to add.
  4. Paste your key or token.
  5. Click Save.

Setting an organisation API key​

  1. Go to the Organisation settings page (available from the dashboard).
  2. Scroll to the API Keys section.
  3. Paste the key into the relevant field.
  4. Click Save.
note

Only organisation owners and admins can view and edit organisation-level API keys.

Removing a key​

Click Delete next to the key you want to remove. The feature that key powers will become unavailable until a new key is set.

warning

Removing an organisation-level key affects all members of the organisation who do not have a personal key configured for that service.