Add your organisation to the Product Comparator Demo

About

The Product Comparator Demo continues to be a powerful and insightful tool for organisations publishing their Product Reference endpoints. The tool calls the nominated organisations:

• Get Products
• Get Product Details
• Get Status
• Get Outages

You can then select Products from the returned data sets and compare these side by side. To view the Product Comparator Demo, you can find it here: https://consumerdatastandardsaustralia.github.io/product-comparator-demo/

Add your organisation to the Product Comparator Demo

For those in the CDR community looking to add your organisation to the Product Comparator Demo:

• Create a Pull Request (PR) on the repository here: https://github.com/ConsumerDataStandardsAustralia/product-comparator-demo
• Or create an Issue on the repository: https://github.com/ConsumerDataStandardsAustralia/product-comparator-demo/issues

And here are some tips when you're adding your Organisation:

• Describe in the Pull Request which organisation you represent and who you are adding
• Ensure your organisation is listed alphabetically in the datasources.json; do not append yours at the bottom of the list
• Verify your Pull Request with the Data Standards Body; send an email to [e-mail] with your Pull Request number
• Transparent background on your logo is preferred

For those who are ready to publish, you can find the repository for the tool here: https://github.com/ConsumerDataStandardsAustralia/product-comparator-demo 

• You will need to fork the repository,
• Commit your changed public/datasources.json to the forked repository,
• Raise a Pull Request against the master branch of the original repository.

Tip

You can test your endpoint before submitting it into the Product Comparator Demo, add your organisation temporarily via the 'Add Bank' option in the 'Banks' section on the Comparator.

The format and content required to add your organisation to the public/datasources.json:

{
"name": "Data-Holder-Brand",
"url": "https://api.dataholder.com.au",
"icon": "https://www.dataholder.com.au/logo.png",
"sectors":["dataholdersector1",...]
}

Once your change is submitted the team will review and comment on any changes OR Approve and merge the change into the repository.

Update: as of November 2020 we have removed the "/cds-au/v1" at the end of the url.