URL format

API Application Programming Interface; a set of clearly defined methods of communication between various software components. URLs are in the following format:

Parameter

Description

HTTP or HTTPS

Note: Participant facing protocol must be HTTPS.

<webservice_host>

Name of the server hosting the service or an external proxy.

Example:

MarketNet

Production:apis.prod.marketnet.com.au:9319/<API><endpoint>

Pre-production: apis.prepod.marketnet.com.au:9319/<API><endpoint>

Internet direct

Production: apis.prod.aemo.com.au:9319/<API><endpoint>

Pre-production: apis.preprod.aemo.com.au:9319/<API><endpoint>

<routing_gateway>

Identifies the AEMO API gateway to which the request must be routed to

Domain Values:

ehub: APIs mediated via webMethods platform (Mediator)

public: APIs mediated via the cloud gateway (e.g. AWS gateway for the GBB project)

<business_name>

Identifies the business name.

Note: The enumerations documented below are not complete. The enumerations will be amended as and when the standards are adopted by other applications:

Enumerations:

<business_name>	Description
NEMRetail	NEM Retail B2B & B2M
NEMWholesale	NEM Wholesale
gbb	Gas Bulletin Board
common	APIs that are common to various markets/applications e.g. eHub Identity Service, eHub Throttling API

<business_function>

API Name - The AEMO system providing the services, e.g. generatorRecall

<API_version>

Version of the API. Starts with <v1>.

This is utilised when multiple versions of the API are supported; enables Participants to gradually transition from one version of the API to another.

Note: No dot releases/versions are allowed such as v1.1

Entities of the business function e.g. /listRecallPlans

Query parameters for GET & DELETE methods e.g. /listRecallPlans?meterExemptionID=1234567890

Path parameters e.g. /listRecallPlans/:exemptionDate