Type Alias ApiClientConfiguration

ApiClientConfiguration: {
    customProtocol?: string;
    disableSecurity?: boolean;
    language?: "sk";
    requestsOrigin?: string;
    secretInitialNonce?: number;
    secretKey?: string;
    serverHost?: string;
    serverPort?: number;
    serverProtocol?: "http" | "https";
}

Client configuration options.

Type declaration

  • Optional ReadonlycustomProtocol?: string

    Custom protocol used with the application, e.g., to launch it - signer://listen.

    Defaults to 'signer'.

  • Optional ReadonlydisableSecurity?: boolean

    Disables using of HMAC in messages and sets requestsOrigin to *

    Make sure you understand the implications on the security!

    Defaults to false.

  • Optional Readonlylanguage?: "sk"

    Language of interface used

  • Optional ReadonlyrequestsOrigin?: string

    Origin the server will be asked to trust

    Influences generated launch URL that sets trusted origin

    Defaults to the current location origin, e.g. 'https://example.com' if available, '*' otherwise.

  • Optional ReadonlysecretInitialNonce?: number

    Secret initial nonce used for the communication.

    Should be cryptographically secure random 32-bit integer generated separately for each session. You can generate this number on the server side and set it on the session so its reused across navigation. There is no need to configure this unless you know what you are doing.

    Defaults to random integer generated on instantiation.

  • Optional ReadonlysecretKey?: string

    Secret key used for the communication.

    Should be cryptographically secure random hex string generated separately for each session. You can generate this key on the server side and set it on the session so its reused across navigation. There is no need to configure this unless you know what you are doing.

    Defaults to random 64-char (256-bit) hex string generated on instantiation.

  • Optional ReadonlyserverHost?: string

    Host of the server - Octosign White Label

    Defaults to '127.0.0.1'

  • Optional ReadonlyserverPort?: number

    Port of the server - Octosign White Label

    Influences also the URL generated to launch the application.

    Defaults to 37200

  • Optional ReadonlyserverProtocol?: "http" | "https"

    Protocol of the server - Octosign White Label

    Defaults to 'http'

Settings

Member Visibility