HubMessageManagement

API Reference
Picture
Postman Collection
NavigationArrow

Getting Started

About the API

The HubMessageManagement API is a B2B SMP APIs used retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource.

Participants can use this resource to:

  • Ensure technical requirements required to connect to e-Hub are validated (for example, appropriate network ports are open). Participants can utilise this function to ensure their systems can connect to e-Hub using their SSL certificates and API keys.

  • Determine if the e-Hub system is operational (ping-pong test).

Getting Access

AEMO provisions access to participants or intending participants in accordance with the accreditation process outlined in the B2B e-Hub Accreditation Process.

During formal onboarding, you will first be given access to Pre-Production and must complete your development/testing there prior to getting access to Production.

FAQ

Q: Can I send my message in JSON?

No. The B2B Messaging APIs only support xml payloads, specifically the aseXML standard. For details on how to use the aseXML format see: aseXML standards

External Docs

Below are a list of external links for additional context to the API or Program:

API Details

Authentication Methods

This API is using the following Security Policies:

Note: The TLS certificates used to access Pre-Production are different from those used to access Production.

Endpoints

Below are the base URLs used for this API:

Environment

Base URL

Data Type

Pre-Production Internet Entry

https://apis.preprod.aemo.com.au:9319/ws/HubMessageManagement/1.0

Test Data

Pre-Production MarketNet Entry

https://apis.preprod.marketnet.net.au:9319/ws/HubMessageManagement/1.0

Test Data

Production Internet Entry

https://apis.prod.aemo.com.au:9319/ws/HubMessageManagement/1.0

Live Data

Production MarketNet Entry

https://apis.prod.marketnet.net.au:9319/ws/HubMessageManagement/1.0

Live Data

Parameters

Paths, Headers, Request Body and Responses can be found in the API Reference (OpenAPI Spec).