IDX Knowledge Library

Basic Power Quality Data API overview

Summary

The Basic Power Quality Data (BPQD Basic Power Quality Data. A subset of power quality data consisting of voltage, current, and phase angle) API Application Programming Interface; a set of clearly defined methods of communication between various software components. overview presentation contains information about:

• Industry Data Exchange See Relevant Rules or Procedures (IDX Industry Data Exchange) platform and its first business function, BPQD.

• Open Authorization 2.0 (OAuth2) instead of Basic Authentication (Basic Auth).

• The existing User Rights Management (URM) for login credentials until the availability of the new Identity Access Management (IDAM) system in 2027.

• The API endpoints available over MarketNet and protected by mTLS certificates.

• CRUD (create, read, update, delete) operations for BPQD messages, using a fire-and-forget model without formal acknowledgements.

• Message signing for non-repudiation, similar to the Gas FRC Hub, and primary and secondary certificates per Participant ID.

• GZIP content encoding.

• Schema versioning with dynamic version selection during transition windows.

• The RFC 9457 standard for error messages, including traceability IDs for troubleshooting.

• Pagination and metadata for message queues with a recommended WebSocket event notification API for real-time updates.

• Message deletion from queues to avoid buildup.

IDX Release 1 - Web Applications and APIs Overview

Summary

The Web Applications and APIs overview presentation contains information about:

• How IDX uplifts data exchange by replacing FTP File transfer protocol and basic authentication with REST The Representational State Transfer API architecture APIs, JSON JavaScript Object Notification payloads, and OAuth 2.0 security.

• How the initial rollout supports basic power quality data only and later releases adds more business functions. A major foundation release is scheduled for 2027.

• How legacy services transition to IDX after the foundation release.

• How IDX provides both web and API access through the Markets Portal, with all UI features also available via APIs to remove the need for screen scraping.

• The four web applications - Transaction Log, Archive, Flow Control, and Other Participant Status – and their matching APIs.

• How the Transaction Log allows participants to view and search all sent and received B2B and B2M messages, with permissions managed through the existing participant management system.

• The Archive service providing access to messages retained for a defined period (for example, 30 days for power quality data). Only outbound archives for receiving participants are available.

• Flow Control providing visibility of message queues for each business function, including options to pause or resume delivery. Delivery automatically stops if a queue exceeds its high watermark and can resume once cleared.

• How Other Participant Status shows participants nearing or exceeding queue limits to help avoid sending to overloaded participants.

• How a metadata API provides archive durations, message patterns, schema versions, and other business function details.

• Websocket event notifications delivering real time alerts such as queue breaches, reducing the need for polling.

• How existing third party gateway solutions should remain compatible, but participants must confirm with vendors.

• How IDX is designed for flexibility, security, and long term extensibility, supporting both manual and automated integration.

IDX Release 1 - Basic Power Quality Data (BPQD) API Demonstration

Summary

The BPQD and supporting IDX APIs demonstration contains information about:

• Demonstration of IDX Release 1 services for Basic Power Quality Data (BPQD) from an API/integration perspective.

• OAuth 2.0 client credentials security model (moving away from Basic Authentication), including how URM entitlements map to OAuth scopes for Release 1.

• Using URM username/password as client credentials (client ID/secret) to obtain access tokens until IDAM is available.

• Access Token API usage, including returned scopes and the recommendation to request scoped tokens to minimise security blast radius.

• Business Function Information API for discovering BPQD configuration such as payload type, delivery pattern (fire-and-forget), archive duration, queue behaviour, and schema version details.

• Submitting BPQD messages using Postman, including required headers such as message context ID, payload signature, schema version, and content encoding.

• Payload handling requirements including message signing for non-repudiation and GZIP content encoding for larger payloads.

• Queue operations for BPQD including listing queued messages, retrieving messages (FIFO behaviour), and deleting processed messages to avoid queue build-up.

• Transaction Logging (Translog) API demonstration to search message records and interpret statuses such as delivery pending, completed, and expired, including message status history.

• Flow Control and Other Participant Status APIs for identifying participants in warn/stopped/manual stop states, and using APIs to stop/resume delivery for a business function.

• Archive API listing to locate archived BPQD messages (including scenarios where messages expire from queues but remain retrievable via Archive).

• Sharing of the presentation pack via MSUG follow-up (requested during the session for distribution on the tech spec portal/knowledge library).

AEMO Gateway Software Overview

Summary

The AEMO Gateway software overview presentation contains information about:

• How the AEMO Gateway software supports integration with the Industry Data Exchange (IDX) platform as part of the broader Data Interchange A set of cooperating applications used to replicate data between AEMO's energy market systems and a participant's DBMS conforming to the MMS Data Model. suite.

• The scope of changes for IDX, including updates to the batcher component (AEMO Gateway) and enhancements to the monitor application to surface IDX-related metadata and status.

• The batcher architecture and concepts (multi-threaded threads, scheduling/control, source, processor/message exchange pattern, translators, and destination).

• The virtual file system approach for source/destination flexibility (for example local file system staging, APIs, FTP/SFTP/FTPS, cloud blobs/queues), and how that supports different integration patterns.

• Eventing variables and translator chains, including extracting values from payloads into variables and using those variables to drive delivery behaviour (such as headers and destination routing).

• The IDX integration pattern where Gateway sits between participant-hosted systems and the IDX API channel, with a future Large File Share (SFTP) channel planned for later releases.

• The default installer staging directory structure (inbox, outbox, and archive folders including done/NACK) as an out-of-the-box enterprise integration point, while remaining highly configurable.

• Configuration for IDX connectivity, including OAuth client credentials (client ID/secret), secure secret handling approaches, and JSON schema validation for inbound and outbound payloads (including schema version awareness).

• An example API send thread configuration for IDX, including extracting metadata from JSON, deriving a message context identifier, and applying digital signatures before delivering to the relevant IDX endpoint with required headers.

• A GUI-based installer for the IDX variant, including selecting which IDX business functions to configure (initially BPQD, with the model designed to scale as more functions are added).

• Monitor/observability enhancements including thread configuration visualisations, local transaction search views, flow control and stopped participant visibility, dashboard widgets, and user/security audit views.