Cesium Ion


A Cesium Ion access token is saved under the program ID "CesiumIon". It is the key the 3D scene depends on most: terrain, several default base maps and location search all load through Cesium Ion.

In Operator it is the "Cesium Ion" field of the Third Party Keys panel. You can read about the record and its requests in Third party keys.

What it powers

In the web Navigator:

  • Cesium World Terrain ("cesiumworldterrain"). Without Cesium Ion, a scene set to it renders flat terrain instead.
  • The Bing Maps base maps ("bingmapsaerial", "bingmapsaerialwithlabels" and "bingmapsroads"), which load from Cesium Ion's world imagery.
  • The "Cesium address" option of the search box, which uses Cesium Ion's geocoder. It is also the fallback when a "Google address" search fails.
  • Cesium Ion tileset Menu Items that do not set their own token.
  • Google Photorealistic 3D Tiles ("GooglePhotoTileset" Menu Items), which load through Cesium Ion when the account has its own "CesiumIon" key. Otherwise they need the "GooglePhotogrammetry" key, see Google.

In the Unreal Navigator, Cesium World Terrain and the Bing Maps and Mapbox base maps all load from Cesium Ion.

In the API, tileset generation ("ui.tileset/{tileset_id}/generate") and other processing jobs are given the key with their configuration.

Cesium Ion proxy

Navigator does not call Cesium Ion directly. It sends Cesium Ion requests to the account's API at "proxy/cesium-ion/", and the API forwards each GET to "https://api.cesium.com/" with the same path and query, replacing any "access_token" query value with the account's key.

Set the key

Save the Cesium Ion access token under "CesiumIon".

Set the Cesium Ion key

Response
// The response is the saved Program Key record.
Javascript example