Introduction
As of 20th March, 2023, most organisations do not have to follow a special procedure to add their organisation’s products to the Product Comparator Demo. The product comparator now discovers public details of registered Data Holder Brands from the CDR Register, and automatically adds the organisation’s product endpoints.
This applies to organisations who maintain a single publicBaseUri
. This is the base path for Unauthenticated Resource URLs including Get Products, Get Status and Get Outages.
Organisations with a Get Products API different to their publicBaseUri
Some organisations are required to follow a special procedure to keep their PRD endpoints up to date in the Product Comparator (Demo) application. This applies to a Data Holder whose Get Products API has a base URL different to the publicBaseUri
associated with the Data Holder in the CDR Register. This includes some Energy Data Holders, such as AGL or Origin.
These organisations are required to modify a file in the Product Comparator demo repository, specifying the Get Products API base URL.
The procedure is as follows:
- Create a Pull Request (PR) on the product-comparator-demo repository by following the
steps below:- Fork the repository.
- Commit your changed
public/override.json
to the forked repository.- The format and content required to add your organisation to the
public/override.json
is similar to the following:
{ "name": "Origin Energy",
"energyPrd": "https://cdr.energymadeeasy.gov.au/origin",
"url": "https://public.mydata.cdr.originenergy.com.au"
}
- The format and content required to add your organisation to the
- Raise a Pull Request against the master branch of the original repository.
Once your change is submitted, the DSB team will review and comment on any changes OR Approve and merge the change into the repository.
- Alternatively, create an issue on the repository:
https://github.com/ConsumerDataStandardsAustralia/product-comparator-demo/issues
When you are adding your organisation:
- In the Issue/Pull Request, describe which organisation you represent and who you are
adding - Verify your Pull Request with the Data Standards Body; send an email to contact@consumerdatastandards.gov.au with your Pull Request number
- Use a logo with a transparent background
Test your CDR public endpoints without adding your organisation
You can test your CDR endpoints even without submitting it into the Product Comparator Demo.
Simply add your organisation temporarily using the blue Add icon located at the bottom-right
corner of the Data Sources section in the Comparator interface.
Note: this is not permanent. Only you can see and interact with this on your web browser
To validate your endpoint before submitting it into the Product Comparator Demo.
Open up the bank panel by clicking 'Banks'
In this panel, scroll down to the bottom of the panel and select the button to add, located on the right hand side of the panel:
A small form will appear to the left of the button, fill out the form with requested details.
Once, you have added the Name of your organisation and URl you can click the Blue Tick button to the right
Congratulations. You're now able to validate if the Product Comparator Demo can initiate a call to your Product Reference Data endpoint.
Update: as of November 2020, we have removed the
/cds-au/v1
at the end of the url.About the Product Comparator
The Product Comparator (Demo) is a proof-of-concept (PoC), developed and maintained by the Data
Standards Body, to demonstrate how the unauthenticated CDR endpoints can be used for viewing and
comparing CDR products, in addition to checking statuses and outages for data holders.
Comments
3 comments
Can you clarify whether there are any linkages between the data defined by organisation on the CDR Portal and the Banking Product Comparator and what is expected from an organisation after they had updated the location of their icons or the public endpoints on the CDR portal?
Hi Johnson Ip,
I assume you are referring to the https://portal.cdr.gov.au/ as the CDR Portal? There is no link between the profile and settings submitted within the CDR Participant Portal and the Banking Product Comparator.
The Banking Product Comparator is a tool built and maintained by the Data Standards Body. The is primarily built to demonstrate what the GET Products and GET Product Detail endpoints look like when hosted in a 'compare' like instance. It is not a competitive or commercial product in the market it's really just a demonstration.
If you would like to update your Icon and Public endpoints we encourage you to raise a Pull Request against the Banking Product Comparator here: https://github.com/ConsumerDataStandardsAustralia/banking-products-comparator
Thanks,
-Jarryd
14th of September 2022.
Please note the URL for the Product Comparator Demo has been changed to: https://consumerdatastandardsaustralia.github.io/product-comparator-demo/
Thanks,
Please sign in to leave a comment.