Interface TGetMapDataWithCredentialsOptions

Fetch map data using a key/secret pair and additional options.

Data-model note: The key you supply determines which data model the API returns.

  • Keys starting with "mik_" use the Maker data model (LocationProfile, LocationCategory).
  • All other keys use the CMS / Enterprise data model (EnterpriseLocation, EnterpriseCategory).

Using the wrong data types for your key type will return empty results.

interface TGetMapDataWithCredentialsOptions {
    analytics?: {
        baseUri?: string;
        externalId?: string;
        logEvents?: boolean;
        sendEvents?: boolean;
    };
    baseAuthUri?: string;
    baseUri?: string;
    environment?: ServiceEnvironment;
    fallbackToNavigatorLanguage?: boolean;
    key: string;
    language?: string;
    layoutId?: "draft";
    mapId: string;
    onMVFParsed?: (mvf: TMVF) => void;
    prefetchTokens?: boolean;
    search?: TSearchOptions;
    secret: string;
    viewId?: string;
}

Properties

analytics? baseAuthUri? baseUri? environment? fallbackToNavigatorLanguage? key language? layoutId? mapId onMVFParsed? prefetchTokens? search? secret viewId?

Properties

Optionalanalytics

analytics?: {
    baseUri?: string;
    externalId?: string;
    logEvents?: boolean;
    sendEvents?: boolean;
}

Analytics configuration.

Type declaration

  • OptionalbaseUri?: string

    Custom base URI for analytics requests. If not provided, the default analytics endpoint will be used. Use the environment setting to switch environments.

  • OptionalexternalId?: string

    The externalId parameter attaches a custom tracking identifier to every analytics event sent during the session. This is useful for correlating Mappedin analytics data with an external system — for example, linking a map session back to a specific marketing campaign, CRM record, or third-party tracking platform.

  • OptionallogEvents?: boolean

    Whether to log analytics events.

    Default

    false
  • OptionalsendEvents?: boolean

    Whether to send analytics events to the server.

    Default

    false

OptionalbaseAuthUri

baseAuthUri?: string

Optionally provide a custom base URL for authentication when obtaining an access token. Use the environment setting to switch environments.

OptionalbaseUri

baseUri?: string

Optionally provide a custom base URL for the Mappedin API request. Use the environment setting to switch environments

Optionalenvironment

environment?: ServiceEnvironment

set the target SDK environment

Default

'us'

Example

const mapData = getMapData({
 key: '',
 secret: '',
 environment: 'eu'
})

OptionalfallbackToNavigatorLanguage

fallbackToNavigatorLanguage?: boolean

Whether to use browser's language settings as fallback if the supplied language code is not available.

Default

true

key

key: string

Mappedin auth key.

Keys starting with "mik_" use the Maker data model (LocationProfile, LocationCategory). All other keys use the CMS/Enterprise data model (EnterpriseLocation, EnterpriseCategory). Using the wrong data types for your key type will return empty results.

Optionallanguage

language?: string

The language of the map data. The ISO 639-1 language code to change to (e.g., 'en' for English, 'fr' for French). Check (EnterpriseVenue.languages) for available languages

OptionallayoutId

layoutId?: "draft"

Load draft (unpublished) enterprise map instead of the live version. Set to "draft" to fetch the latest unpublished changes. Leave unspecified to load the published live data.

Requires an Enterprise API key. Only applicable to maps made in Mappedin CMS.

Default

undefined

mapId

mapId: string

Mappedin map ID.

OptionalonMVFParsed

onMVFParsed?: (mvf: TMVF) => void

Callback for when the Mappedin map data has been fetched and parsed as Mappedin Venue Format (MVF) data.

Type declaration

    • (mvf: TMVF): void

    • Parameters

      • mvf: TMVF

        Parsed MVF data.

      Returns void

OptionalprefetchTokens

prefetchTokens?: boolean

Fetch bearer and SAS tokens for the map ahead of time and keep them up to date in the background.

Default

true

Optionalsearch

search?: TSearchOptions

secret

secret: string

Mappedin auth secret.

OptionalviewId

viewId?: string

Load different view of mvf data based on configId

Settings

Member Visibility

On This Page

Properties