Skip to Content
APIMainInterface: SDKConfig

Interface: SDKConfig

Interface that defines the available configuration options for the SDK.

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://integration.mapvx.com ’ for staging.

Default Value

https://public-api.mapvx.com


cache?

optional cache: SDKCacheConfig;

Cache configuration options Controls caching behavior, persistence, and limits


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


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.

Last updated on