@mediafly/frontend-api - v20.4.1
    Preparing search index...

    Interface EnvironmentConfig

    interface EnvironmentConfig {
        baseUrl: string;
        insightsApiHost: string;
        launchpadReadOnlyApiHost: string;
        loginUrl: string;
        mcodeEntryUrl: string;
        notificationsApiHost: string;
        shareslug?: string;
        viewerApiHost: string;
        viewerAuthUrl: string;
        workflowsApiHost: string;
    }
    Index
    baseUrl: string

    The url onto which apiproxy requests should be appended. For example: https://apiproxy.mediafly.com/

    insightsApiHost: string

    The host that should be used for Insights api requests. Insights has a staging and prod api. For example: insightsapi.mediafly.com

    launchpadReadOnlyApiHost: string

    The host that should be used for Launchpad read only api requests. For example: https://launchpadreadonlyapi.mediafly.com

    loginUrl: string

    The url that should be used to redirect the user to an authentication UI. This is the url that allows the user to fully log in (i.e., they are not bound). We avoid the Viewer auth url in this case because it will have one fewer redirect hop.

    For example: https://login.mediafly.com/{mcode}#/login?returnUrl={url}

    mcodeEntryUrl: string

    The url that should be used to redirect the user to the mcode entry UI. Typically, apps implement this as the bare host url (with no mcode). For example: https://insights.mediafly.com

    notificationsApiHost: string

    The host that should be used for (push) notifications api requests. Notifications has a staging and prod api. For example: notificationsapi.mediafly.com

    shareslug?: string

    This is a header that will include the shareSlug extracted from the URL's path. This is used when a guest user opens a share and stored in the jwt cookie to separate different share sessions.

    For example: https://viewer.mediafly.com/{mcode}/s/{shareSlug}#/...

    viewerApiHost: string

    The host that should be used for Viewer api requests. Viewer has test, staging, and prod apis. For example: viewer.mediafly.com

    viewerAuthUrl: string

    The url that should be used to redirect the user to Viewer's auth UI. This is used when the user is bound but doesn't have a valid session. Viewer automatically displays UI to reauth the user (could be PIN, SSO or U/P).

    For example: https://viewer.mediafly.com/{mcode}#/login?returnUrl={url}

    workflowsApiHost: string

    The host that should be used for Workflows api requests. Workflows has test, staging, and prod apis. For example: workflowsapi.mediafly.com