Interface: MapVxApiEndpoints
Optional overrides for the MapVX API hosts that historically differ from
SDKConfig.apiUrl. In production the SDK data API lives on
public-api.mapvx.com (see apiUrl) while routing, health pings and the legacy transport endpoints
live on api.mapvx.com; these were previously hardcoded. Each field defaults to
https://api.mapvx.com so existing behavior is unchanged, and can be pointed elsewhere
independently — e.g. an offline totem points them all at its local edge server so routes resolve
without reaching the public internet.
mapvxRequestContext headers (X-MapVx-*, mvx-product) are only attached to requests whose
resolved host is under *.mapvx.com — the same rule that already applies to
SDKConfig.apiUrl. Pointing any of these fields at a different host
(e.g. a totem’s local edge server) means that host will not receive those headers.
Extended by
Properties
healthApiUrl?
optional healthApiUrl?: string;Base host for the health ping endpoint (/api/sdk/v2/health).
Default Value
https://api.mapvx.com
legacyApiUrl?
optional legacyApiUrl?: string;Base host for the legacy transport endpoints (/api/sdk/vehiclesWithSchedules, /api/sdk/stops).
Default Value
https://api.mapvx.com
portalApiUrl?
optional portalApiUrl?: string;Base host for the /api/portal/* (bearer-authenticated) surface, when it is served separately from
the /api/sdk/v2/* (api-key) surface addressed by SDKConfig.apiUrl.
Unlike the three hosts above it does NOT default to https://api.mapvx.com — it falls back to
apiUrl, because single-host setups serve both surfaces from the same origin.
routeApiUrl?
optional routeApiUrl?: string;Base host for routing endpoints (/sdk/route, /sdk/v2/route, /sdk/liveroute,
/sdk/routes_for_origin, /sdk/cache_timestamp).
Default Value
https://api.mapvx.com