Skip to main content

Core Concepts

Provider​

All SDK functionality flows from NexlaConnectProvider at the root of your component tree. It authenticates with the Nexla API, fetches connectors and credentials scoped to the current user, and provides state and actions to every hook and component beneath it.

<NexlaConnectProvider>       ← auth, state, actions
  <NexlaThemeProvider>       ← CSS variables (styled components only)
    <YourApp />              ← useNexlaConnect(), useCredentials(), etc.
  </NexlaThemeProvider>
</NexlaConnectProvider>

All hooks and styled components must be rendered inside a NexlaConnectProvider. See API Reference for all provider props.

Credentials​

A Credential represents a connected third-party account — the primary data type returned by most SDK operations. Read credentials via useNexlaConnect().credentials or the convenience hook useCredentials().

Key fields: id, name, credentials_type, connector, vendor, verified_status. See API Reference for the full type.

Connectors​

A Connector represents an available integration — its name, logo, and supported auth methods. The SDK fetches connectors filtered to the keys you pass in the connectors prop.

Some connectors support multiple auth methods (e.g. "OAuth" and "API Key"). The useConnectorForm hook exposes authTemplates and setTemplate to switch between them.

End-User Scoping​

Both applicationId and endUserId are required on the provider. Together, they scope all credential operations to a specific user within your application:

  • applicationId — from your SDK Application registration. Credentials are filtered to this application. The server validates your service key belongs to this application at startup.
  • endUserId — your own user identifier (any stable string up to 128 chars). Each user only sees credentials they created.

Changing either value automatically invalidates the cache and fetches fresh data for the new scope. The backend enforces one credential per (application, end_user, connector_type).

See Authentication for setup details.

Connector Keys​

Each connector has a unique key used throughout the SDK (e.g. gdrive, asana_api, sf_api, salesforce). Connector keys match the name field returned by the Nexla API (GET /vendors). You can also inspect vendor.name on any Credential object.

Next Steps​