EngineBaseURL
public enum EngineBaseURL : UInt32, CaseIterable, Codable
Lists the available HERE SDK endpoints that can be customized with a custom backend base URL.
-
Indicates a
SearchEngineendpoint. Note that the provided string value will replace the base URL. The endpoint names for this engine are “v1/discover”, “v1/geocode”, “v1/revgeocode”, “v1/autosuggest”, “v1/lookup” and “v1/browse”. A valid base string value could look like “www.my-company.com”. An example of the resulting URL for the first endpoint looks like this: “https://www.my-company.com/v1/discover” appended with query data. You need to ensure that the provided base URL supports all required endpoints.Declaration
Swift
case searchEngine -
Indicates a
RoutingEngineendpoint. Note that the provided string value will replace the base URL. The endpoint names for this engine are “v8/routes”, “v8/import”. A valid base string value could look like “www.my-company.com”. An example of the resulting URL for the first endpoint looks like this: “https://www.my-company.com/v8/routes” appended with query data. You need to ensure that the provided base URL supports all required endpoints.Declaration
Swift
case routingEngine -
Indicates base url for
Authentication. Note that the provided string value will replace the base URL. The endpoint name for this base url is “oauth2/token”. A valid base string value could look like “www.my-company.com”. An example of the resulting URL for the endpoint looks like this: “https://www.my-company.com/oauth2/token” appended with query data. You need to ensure that the provided base URL supports required endpoint.Declaration
Swift
case authentication -
Specifies the endpoint URL for a map catalog. This is only relevant for the Navigate license that uses OCM based map data when a custom catalog configuration should be loaded. By default, the data Service proxy, in short
EngineBaseURL.dsProxy, is set to “https://direct.data.api.platform.here.com/direct/v1”. When a custom catalog should be used, then the HERE SDK will internally do a lookup request to find out which URL to use to access catalog. In order to bypass this extra request, we recommend to set the URL upfront when initializing the HERE SDK. For example, a validEngineBaseURL.dsProxyfor a custom catalog may look like this: “https://data.api.platform.yourcompany.com/direct/v1”. Note that this is not a network proxy setting. If you do not load a custom catalog configuration, you can ignore this setting.Declaration
Swift
case dsProxy -
Indicates a
Traffic Dataendpoint. Note that the provided string value will replace the base URL. This is only relevant for TrafficEngine. For traffic incident and flow presented in the map view, please useEngineBaseURL.trafficVectorTileService.Declaration
Swift
case trafficData -
Indicates a
Traffic Vector Tile APIendpoint. Note that the provided string value will replace the base URL. This is only relevant for traffic presented in the map view. For the TrafficEngine, please useEngineBaseURL.trafficData.The service needs to comply with https://www.here.com/docs/bundle/traffic-vector-tile-api-v2-api-reference/page/index.html The endpoint name for this engine is “v2/traffictiles”. A valid base string value could look like “www.my-company.com”. The resulting URL looks like this: “https://www.my-company.com/v2/traffictiles/{layer}/mc/{z}/{x}/{y}/omv”, with concrete tile IDs in {x}, {y}, {z} and {layers} in (flow, incidents). You need to ensure that the provided base URL supports all required endpoints.
Declaration
Swift
case trafficVectorTileService -
Indicates a
Raster Tile APIendpoint. Note that the provided string value will replace the URL template. A valid URL template value could look like: “https://www.my-company.com/satellite.day/{z}/{x}/{y}/512/jpg”Declaration
Swift
case rasterTileService -
Indicates a
IsolineRoutingEngineendpoint. Note that the provided string value will replace the base URL. The endpoint names for this engine are “v8/isolines”. A valid base string value could look like “www.my-company.com”. An example of the resulting URL for the first endpoint looks like this: “https://www.my-company.com/v8/isolines” appended with query data. You need to ensure that the provided base URL supports all required endpoints.Declaration
Swift
case isolineRoutingEngine