Interface BackendApiOptions

interface BackendApiOptions {
    apiKey?: string;
    backendHost: string;
    headers?: {
        [key: string]: string;
    };
    proxyHost?: string;
    webSocketHost?: string;
    webSocketOptions?: BackendWebSocketOptions;
}

Properties

apiKey? backendHost headers? proxyHost? webSocketHost? webSocketOptions?

Properties

Optional apiKey

apiKey?: string

The Nevermined API Key. This key identify your user and is required to interact with the Nevermined API. You can get your API key by logging in to the Nevermined App.

See

https://docs.nevermined.app/docs/tutorials/integration/nvm-api-keys

backendHost

backendHost: string

The host of the backend server

Optional headers

headers?: {
    [key: string]: string;
}

Additional headers to send with the requests

Type declaration

  • [key: string]: string

Optional proxyHost

proxyHost?: string

The host of the Nevermined Proxy

Optional webSocketHost

webSocketHost?: string

The host of the websocket server

Optional webSocketOptions

webSocketOptions?: BackendWebSocketOptions

Configuration of the websocket connection

Settings

Member Visibility

Theme

On This Page

apiKeybackendHostheadersproxyHostwebSocketHostwebSocketOptions