@finapi/finapi-js-loader/dist/mods/modProcessctl.d.ts

finAPI JS Loader

import { Properties } from '../types';
export interface ModProcessctlProperties extends Properties {
    /**
     * Server URL of the Process Controller API.
     *
     * @default https://di-processctl-finapi-general-live.finapi.io
     */
    processctlServer?: string;
    /**
     * Server URL of the Process Controller Solutions API.
     *
     * @default https://di-processctl-finapi-general-live.finapi.io
     */
    processctlSolutionsServer?: string;
    /**
     * Widget's authentication can be done by providing either a `processToken`
     * or a `mandatorId`. If both are provided, the `processToken` will take
     * precedence.
     *
     * The `processToken` is a UUID and must be obtained from
     * the API before authentication by providing Client credentials.
     */
    processToken?: string;
    /**
     * Widget's authentication can be done by providing either a `processToken`
     * or a `mandatorId`. If both are provided, the `processToken` will take
     * precedence.
     *
     * After registering, you will be provided with a UUID known as the
     * 'mandatorId'. Once you provide the 'mandatorId', the widget will
     * automatically generate a 'processToken' for the predefined Client
     * associated with your Mandator.
     */
    mandatorId?: string;
    /**
     * `clientReference` will be considered only when you authenticate with
     * `mandatorId`.
     *
     * The `clientReference` setting can be used to customize the widget's
     * process. Not all widgets use this setting, so please refer to the widget's
     * documentation for more details.
     */
    clientReference?: string;
    /**
     * `clientReferenceKey` will be considered only when you authenticate with
     * `mandatorId`.
     *
     * The `clientReferenceKey` allows you to label the widget instance with a
     * keyword, so you can monitor the success of the widgets with the given
     * reference key.
     *
     * For instance, if you are running various campaigns to advertise a new
     * product, you could provide campaign identifiers in the reference key.
     * Then, the user usage data can be retrieved from the Process Controller
     * API.
     */
    clientReferenceKey?: string;
}