Member Junction
    Preparing search index...

    Interface NoviConnectionConfig

    Per-connection configuration for the Novi AMS connector.

    Novi AMS has NO shared API host — every tenant runs on their own website domain (https://www.<association>.org/api/). The connector resolves the tenant base URL from CompanyIntegration.Configuration.TenantBaseURL at runtime. Auth is a single raw API key placed verbatim after Basic in the Authorization header (NOT base64 of user:password — see BuildHeaders).

    interface NoviConnectionConfig {
        ApiBaseUrl?: string;
        APIKey?: string;
        MaxRetries?: number;
        MinRequestIntervalMs?: number;
        RequestTimeoutMs?: number;
        TenantBaseURL?: string;
    }
    Index

    Properties

    ApiBaseUrl? APIKey? MaxRetries? MinRequestIntervalMs? RequestTimeoutMs? TenantBaseURL?

    Properties

    ApiBaseUrl?: string

    Non-secret API host override (e.g. a local mock for replay testing). When set, it wins over TenantBaseURL. Mirrors ORCID/GrowthZone ApiBaseUrl — required for the mock-floor e2e testability tier.

    APIKey?: string

    The raw API key. Used verbatim as Authorization: Basic <apiKey> — this is NOT standard HTTP Basic Auth (no base64 of user:password). From the credential store.

    MaxRetries?: number

    Maximum retries for rate-limited / transient failures. Default: 4.

    MinRequestIntervalMs?: number

    Minimum interval between outbound requests (ms). Default: 50 (~20 req/s ceiling).

    RequestTimeoutMs?: number

    HTTP request timeout in milliseconds. Default: 30000.

    TenantBaseURL?: string

    Per-tenant base URL, e.g. https://www.myassociation.org or https://www.myassociation.org/api. The connector normalizes a trailing /api so resource paths (which already start /api/...) are not doubled. Required.

    Settings

    Member Visibility

    On This Page

    Properties