Partner API Overview

The Partner API provides high-performance access to pre-computed JSON snapshots of site data. It is specifically designed for embedding into partner dashboards and third-party applications where low latency and high reliability are critical.

Key Features

• Blazing Fast: Responses are served directly from a high-performance cache.
• Efficient Caching: Full support for ETag-based conditional GETs (HTTP 304).
• Reduced Bandwidth: Only download data when it has actually changed.
• Simplified Auth: Uses a simple API key scoped to specific sites.

Base URL

https://8el3o25tc1.execute-api.af-south-1.amazonaws.com/prod

Authentication

The Partner API uses an x-api-key header for authentication. This key is specifically scoped to the sites you are permitted to access.

x-api-key: YOUR_PARTNER_API_KEY

Snapshot Types

The following pre-computed snapshots are currently available:

ETag Caching

To minimize latency and data transfer, the Partner API includes an ETag header in every successful response. When making subsequent requests, you should include this value in the If-None-Match header.

• If the data has not changed, the server will return an empty HTTP 304 Not Modified response.
• If the data has changed, the server will return HTTP 200 OK with the fresh data and a new ETag.

The Ona SDK handles this caching logic automatically.

Endpoints

KPI Rollup Snapshot

GET /kpi-rollup

Returns a summary of key performance indicators for the site.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | site_id | string | Yes | The identifier for the site (e.g., Sibaya). |

from ona_platform import OnaClient

client = OnaClient(partner_api_key="your_key")
snapshot = client.partner_api.get_kpi_rollup(site_id="Sibaya")
print(snapshot['performance']['system_pr'])

const { OnaSDK } = require('@asoba/ona-sdk');

const sdk = new OnaSDK({ partnerApiKey: 'your_key' });
const snapshot = await sdk.partnerApi.getKpiRollup({ site_id: 'Sibaya' });
console.log(snapshot.performance.system_pr);

curl -i -X GET "https://8el3o25tc1.execute-api.af-south-1.amazonaws.com/prod/kpi-rollup?site_id=Sibaya" \
  -H "x-api-key: YOUR_PARTNER_API_KEY"

Maintenance Signals

GET /maintenance-signals

Returns active alerts and prioritized maintenance tasks.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | site_id | string | Yes | The identifier for the site. | | since | string | No | Filter signals occurring after this timestamp (ISO 8601). | | severity | string | No | Filter by severity: Critical, High, Medium, Low. |

signals = client.partner_api.get_maintenance_signals(
    site_id="Sibaya", 
    severity="High"
)

const signals = await sdk.partnerApi.getMaintenanceSignals({ 
  site_id: 'Sibaya', 
  severity: 'High' 
});

curl -X GET "https://8el3o25tc1.execute-api.af-south-1.amazonaws.com/prod/maintenance-signals?site_id=Sibaya&severity=critical" \
  -H "x-api-key: YOUR_PARTNER_API_KEY"

Forecast Snapshot

GET /forecast-snapshot

Returns the most recent solar energy forecast rollup for the entire site.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | site_id | string | Yes | The identifier for the site. | | horizon | string | No | Forecast window (e.g., 24h, 48h). Defaults to 24h. |

forecast = client.partner_api.get_forecast_snapshot(site_id="Sibaya")

const forecast = await sdk.partnerApi.getForecastSnapshot({ site_id: 'Sibaya' });

curl -X GET "https://8el3o25tc1.execute-api.af-south-1.amazonaws.com/prod/forecast-snapshot?site_id=Sibaya" \
  -H "x-api-key: YOUR_PARTNER_API_KEY"

Maintenance Schedule

GET /maintenance-schedule

Returns the preventive-maintenance task list for the next 90 days, derived per inverter from detected anomaly frequency and manufacturer service intervals.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | site_id | string | Yes | The identifier for the site. |

Response shape

{
  "site_id": "Sibaya",
  "generated_at": "2026-05-30T03:39:39Z",
  "horizon": { "start": "2026-05-30", "end": "2026-08-28" },
  "tasks": [
    {
      "asset_id": "INV-1000000054495190",
      "task_type": "inspection",
      "reason": "35 anomalies detected in the last 2 days",
      "recommended_date": "2026-06-06",
      "estimated_duration_hours": 2.0,
      "priority": "High"
    }
  ],
  "summary": { "total_tasks": 5, "by_priority": { "High": 5 }, "by_task_type": { "inspection": 5 } }
}

schedule = client.partner_api.get_maintenance_schedule(site_id="Sibaya")
print(schedule['summary']['total_tasks'])
for task in schedule['tasks']:
    print(task['recommended_date'], task['asset_id'], task['task_type'], task['priority'])

const schedule = await sdk.partnerApi.getMaintenanceSchedule({ site_id: 'Sibaya' });
console.log(schedule.summary.total_tasks);

curl -X GET "https://8el3o25tc1.execute-api.af-south-1.amazonaws.com/prod/maintenance-schedule?site_id=Sibaya" \
  -H "x-api-key: YOUR_PARTNER_API_KEY"