Interface: SDKConfig
Interface that defines the available configuration options for the SDK.
Extends
Properties
apiUrl?
optional apiUrl?: string;The base API URL for the SDK requests. Can be used to point to different environments or custom servers. For example: ‘https://public-api.mapvx.com ’ for production, ‘https://api.mapvx.dev ’ for staging.
Default Value
https://public-api.mapvx.com
cache?
optional cache?: SDKCacheConfig;Cache configuration options Controls caching behavior, persistence, and limits
healthApiUrl?
optional healthApiUrl?: string;Base host for the health ping endpoint (/api/sdk/v2/health).
Default Value
https://api.mapvx.com
Inherited from
MapVxApiEndpoints.healthApiUrl
lang?
optional lang?: string;The default language to be used in the SDK For example: ‘en’ for English, ‘es’ for Spanish, etc
Default Value
en
legacyApiUrl?
optional legacyApiUrl?: string;Base host for the legacy transport endpoints (/api/sdk/vehiclesWithSchedules, /api/sdk/stops).
Default Value
https://api.mapvx.com
Inherited from
MapVxApiEndpoints.legacyApiUrl
mapvxRequestContext?
optional mapvxRequestContext?: MapVxRequestContext;Optional context sent with every request to public-api.mapvx.com. Set this in totem or directory apps so the backend receives baseUrl, totemId, originId, institutionId, parentPlace, institutionName, fullUrl, and mvxProduct via request headers.
portalApiUrl?
optional portalApiUrl?: string;Optional host for the /api/portal/* (bearer-authenticated) surface, when it is served separately
from the /api/sdk/v2/* (api-key) surface addressed by apiUrl. Defaults to
apiUrl when omitted (single-host setups). Use it for split backends, e.g. the SDK/main
and portal apps on different hosts.
Overrides
MapVxApiEndpoints.portalApiUrl
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