> ## 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.

# APEX API

> Connect APEX API to KODE OS for meters data

> Connect APEX API to KODE OS for meters data integration

## Overview

Use this integration to connect your APEX multi-protocol edge gateway to KODE OS. You can discover meters from your uploaded device file, then combine scheduled polling with webhooks so status and related readings land in KODE OS without manual exports.

| Property            | Value                |
| ------------------- | -------------------- |
| **System Type**     | Meters               |
| **Communication**   | REST + Webhook       |
| **Collection**      | Hybrid (Pull + Push) |
| **Collection Mode** | HISTORICAL           |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data
* Receive Webhook Data
* File Validation

## Prerequisites

* An active account with APEX API and access to their API or developer portal
* KODE OS environment with access to Data Sources

## Configure Webhook

This integration uses webhooks for real-time data delivery. After creating the connector in KODE OS:

1. Copy the webhook URL provided on the connector detail page
2. In the APEX API platform, navigate to the webhook or notification settings
3. Add a new webhook endpoint using the KODE OS URL
4. Configure the authentication header as specified on the connector detail page
5. Save and enable the webhook

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **APEX API**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field    | Required | Type | Description                                                               |
| -------- | -------- | ---- | ------------------------------------------------------------------------- |
| **File** | Yes      | file | An upload file used during discovery (e.g., device whitelist spreadsheet) |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the APEX API system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## Devices and Points

When you discover devices from APEX API, KODE OS maps them to the following device types and data points:

### Meter

Canonical Type: `default`

| # | Point    | Description         | Unit | Writable | Collection |
| - | -------- | ------------------- | ---- | -------- | ---------- |
| 1 | `Status` | Numeric status code | --   | No       | Webhook    |

## What Data You Get

### Point History

Time-series readings including Status, collected at regular intervals from connected devices

### Polling Schedule

* **Point History**

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Use Cases

Once connected, this integration enables you to:

* Aggregate utility consumption data (electricity, gas, water, steam) in a unified dashboard
* Detect abnormal consumption patterns and potential waste or leaks
* Generate utility cost reports and benchmark buildings in your portfolio

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Double-check all credential fields match the values from the APEX platform.
  </Accordion>

  <Accordion title="Webhook data not arriving">
    Verify the webhook URL is correctly registered in the APEX platform. Check that the authentication header matches the value from the KODE OS connector detail page. Ensure the APEX system can reach the KODE OS webhook endpoint over the network.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the APEX system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the APEX API.
  </Accordion>
</AccordionGroup>