> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Connect your first external system to KODE OS and start collecting data in minutes

> Connect your first external system to KODE OS and start collecting data

This guide walks you through connecting an external system to KODE OS, from finding the right integration to verifying data flow. The entire process takes a few minutes once you have your vendor credentials ready.

## Before You Begin

<Info>
  Make sure you have the following before you start:

  * **KODE OS access** -- a user account with permission to manage data sources in the target building
  * **Vendor credentials** -- the API key, username/password, OAuth client ID/secret, or certificates required by the external system (check the specific [integration page](/products/integrations/catalog) for what your vendor requires)
  * **Network connectivity** -- KODE OS must be able to reach the external system's API endpoint (verify firewall rules and VPN access for on-prem systems)
</Info>

<Steps>
  <Step title="Open Data Sources">
    Navigate to your building in KODE OS. In the left-side menu, click `Data Sources`. This page displays any connectors you have already configured for this building.
  </Step>

  <Step title="Find your integration">
    Click `API Catalog` in the left menu. Browse integrations by system type (access control, metering, occupancy, lighting, and more) or use the search bar to find your vendor by name.

    Click on the integration to view its supported entities, collection schedules, and available data fields.

    <Tip>
      Not sure which integration to use? Browse the full [Integrations Catalog](/products/integrations/catalog) to see all 200+ supported systems organized by category.
    </Tip>
  </Step>

  <Step title="Add a datasource">
    Click `+ Add Datasource` at the top right of the integration detail page. A three-page setup flow opens.

    **Page 1 -- Credentials and settings**

    Enter the connection details for the external system. The required fields vary by integration but typically include:

    * **URL** -- base URL or IP address of the external system
    * **Authentication** -- username/password, API key, OAuth credentials, or certificates
    * **Dynamic fields** -- some integrations show additional fields (such as Organization ID or Site ID) that populate automatically after your credentials are validated

    Click `Next` once the fields are filled and validated.

    **Page 2 -- Entity enablement**

    Toggle which data entities you want to collect. Options vary by integration and may include Point History, Work Orders, Alarms, Audit Logs, or Schedule Sync. All available entities are enabled by default -- disable any you do not need.

    **Page 3 -- Polling frequency**

    Set how often KODE OS polls each enabled entity. Configure the time unit (seconds, minutes, hours, or days), the interval, and the start time. Each integration defines minimum and maximum polling intervals.

    Click `Save` to create the connector.
  </Step>

  <Step title="Test the connection">
    On the connector detail page, click `Test Connection`. KODE OS authenticates with the external system using your credentials and verifies that the API endpoint is reachable.

    <Check>
      A successful test confirms the URL is reachable, credentials are valid, and the external system is responding correctly.
    </Check>

    If the test fails, check that the URL is correct, credentials have not expired, and firewall rules allow outbound connections from KODE OS to the external system.
  </Step>

  <Step title="Run discovery">
    Click `Discover` on the connector detail page. KODE OS queries the external system and returns a list of available devices, data points, schedules, and assets.

    Review the discovered items and select which ones to register in KODE OS. Selected items are saved and ready for data collection.

    <Note>
      Not all integrations support discovery. Webhook-only and MQTT integrations receive data as it arrives and do not require a discovery step.
    </Note>
  </Step>

  <Step title="Verify data flow">
    After the first polling interval passes, check the connector detail page:

    * The **collection chart** shows data volume over time
    * The **current status** indicator shows whether the connector is up
    * Individual **entity sections** display collected records or time-series data

    If data appears in the chart, your integration is working. Navigate to `Cloud BMS` to map ontology to your discovered devices for consistent naming across your building portfolio.
  </Step>
</Steps>

## What's Next

<CardGroup cols={2}>
  <Card title="Managing Connectors" icon="plug" href="/products/integrations/get-started/managing-connectors">
    Learn how to modify, monitor, and troubleshoot your connectors
  </Card>

  <Card title="Integrations Catalog" icon="grid-2x2" href="/products/integrations/catalog">
    Browse all 200+ supported integrations by system category
  </Card>

  <Card title="Discovery" icon="search" href="/products/integrations/capabilities/discovery">
    Understand how device, point, schedule, and asset discovery works
  </Card>

  <Card title="Data Collection" icon="database" href="/products/integrations/capabilities/data-collection">
    Learn about pull vs. push collection and snapshot, delta, and historical data types
  </Card>
</CardGroup>