Documentation Index

Welcome to the official AmalHES system documentation. This reference provides comprehensive guidelines for integrating, managing, and automating meter communication networks, data concentrator units (DCUs), and smart grid analytics.

To begin interfacing with the platform, generate an API key from your portal dashboard and configure your cellular or RF Mesh gateways to forward payload traffic to your designated endpoint.

# Initialize AmalHES Node SDK
npm install @amalhes/sdk-core

# Set environment credentials
export AMALHES_API_KEY="am_live_998371625d8a"

All REST API requests must include a valid Bearer Token in the HTTP Authorization header. Tokens can be scoped for read-only telemetry access or full DCU administrative control.

// Sample authenticated request header
Authorization: Bearer am_live_998371625d8a
Content-Type: application/json

Access real-time active energy registers, power quality metrics, instantaneous voltage, and load profile historical arrays across single-phase and polyphase smart meters.

curl -X GET "https://api.amalhes.com/v1/meters/MTR_88301/telemetry" \
  -H "Authorization: Bearer am_live_998371625d8a"

Query localized transformer energy balance, run non-technical loss (NTL) detection algorithms, and retrieve automated outage boundary polygons.

Configure Webhooks to receive immediate alerts for meter tampering, line bypass events, reverse current detection, and power outage events.

Official client libraries are available for Python, Node.js, Go, and Java to facilitate seamless Head-End System protocol integration.

Standard API keys support up to 1,000 requests per minute. Batch telemetry submission endpoints allow up to 10,000 meter records per single payload.

AmalHES uses standard HTTP response codes to indicate request status. Standard error payloads return structured JSON detailing specific fault codes.