Elementor #706 – Scigrow

Scigrow IEC 61968-9 Metering Data Exchange API - Interactive Documentation

📋 API Overview

This API enables secure and interoperable communication between metering systems, customer information systems, and advanced metering infrastructure components.

Key Capabilities:

End Device Controls: Send control commands (load control, price signals, remote disconnect/reconnect)
Meter Readings: Exchange interval data, register reads, and billing data
End Device Events: Report power outages, tampering alerts, and operational events
Configuration Management: Configure devices, meters, usage points, and communication modules
Security: JWT Bearer tokens and API Key authentication with HTTPS
Data Quality: Full support for IEC 61968-9 energy measurements, phases, and units

Quick Start Examples:

1. Submit a Meter Reading

POST /meter-readings
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "readings": [
    {
      "meterId": "1234LG",
      "readingType": "intervalData",
      "readingDateTime": "2024-01-15T10:00:00Z",
      "value": 1234.56,
      "unit": "kWh",
      "multiplier": 0,
      "phase": "ABC",
      "energyDirection": "forward",
      "quality": "good"
    }
  ]
}
            

2. Send a Control Command

POST /end-device-controls
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "controls": [
    {
      "deviceId": "3dc53ee5-777e-50b4-8699-a1c224d493d",
      "controlType": "loadControlSignal",
      "controlValue": "50",
      "controlUnit": "kW",
      "effectiveDateTime": "2024-01-15T10:30:00Z",
      "reason": "Demand response event",
      "priority": "high"
    }
  ]
}
            

3. Report an End Device Event

POST /end-device-events
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "deviceId": "3dc53ee5-777e-50b4-8699-a1c224d493d",
  "eventType": "tamperingAlert",
  "eventDateTime": "2024-01-15T10:15:00Z",
  "severity": "high",
  "description": "Potential tampering detected on meter",
  "eventCode": "TAM001"
}
            

4. Remote Disconnect

POST /end-device-controls
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "controls": [
    {
      "deviceId": "3dc53ee5-777e-50b4-8699-a1c224d493d",
      "controlType": "remoteDisconnect",
      "reason": "Non-payment",
      "priority": "high"
    }
  ]
}
            

🔐 Authentication

The API supports two authentication methods:

JWT Bearer Token

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

API Key

X-API-Key: your-api-key-here

📊 Supported Energy Measurements

Active Energy: Forward, Reverse, Net, Total
Reactive Energy: Q1+Q2, Q1+Q3, Q1+Q4, Q2+Q3, Q2+Q4, Q3+Q4
Apparent Energy: Forward, Reverse, Net, Total
Power: Active, Reactive, Apparent
Electrical Quantities: Voltage, Current, Frequency, Power Factor

Supported Units:

Energy: Wh, kWh, MWh
Power: W, kW, MW, VAr, kVAr, VA, kVA
Electrical: V (Voltage), A (Current), Hz (Frequency)
Power Factor: PF (dimensionless)

Phase Specifications:

Single Phase: A, B, C, N (neutral)
Line-to-Neutral: AN, BN, CN
Line-to-Line: AB, BC, CA
Three-Phase: ABC
Neutral-to-Ground: N₁, N₂

🛡️ Security Features

HTTPS Only: All communications must use TLS 1.2 or higher
Authentication: JWT Bearer tokens or API keys
Authorization: Role-based access control
Rate Limiting: 100 requests/minute per API key
Input Validation: All inputs validated against schema
Audit Logging: All API calls logged for compliance
Data Encryption: Data encrypted in transit and at rest
Security Headers: HSTS, CSP, X-Frame-Options, etc.

📡 API Endpoints

Method	Endpoint	Description
POST	/end-device-controls	Create control command
GET	/end-device-controls	List controls
POST	/meter-readings	Submit meter readings
GET	/meter-readings	Query meter readings
POST	/end-device-events	Report end device event
GET	/end-device-events	Query end device events
POST	/end-device-config	Create device configuration
GET	/end-device-config	List device configurations
POST	/meter-config	Create meter configuration
POST	/usage-point-config	Create usage point configuration
POST	/com-module-config	Create communication module configuration
GET	/health	Health check
GET	/status	System status

✅ IEC 61968-9 Compliance

This API specification fully implements the IEC 61968-9:2024 Edition 3.0 standard:

✓ All required message types (EndDeviceControls, MeterReadings, EndDeviceEvents, Configurations)
✓ Complete energy measurement enumerations
✓ Phase specifications (single, line-to-neutral, line-to-line, three-phase)
✓ Unit specifications and power-of-ten multipliers
✓ Data quality indicators
✓ Security and encryption requirements
✓ Error handling and validation
✓ Audit logging and compliance tracking

📚 Additional Resources

IEC 61968-9:2024: Application Integration at Electric Utilities - System Interfaces for Distribution Management - Part 9
OpenAPI 3.0: https://spec.openapis.org/oas/v3.0.3
REST API Best Practices: https://restfulapi.net/
Support Email: support@propertywallet.co.za

🔌Scigrow API IEC 61968-9 Metering Data Exchange API