About our API
An API, or application programming interface, lets 2 different computer systems talk to each other and share information automatically.
Our API connects your system with ours. It lets you add, remove and update associated providers in a single submission (in bulk), instead of submitting individual notifications.
Who can use the API
You can use the API if you're a registered provider who needs to notify us about changes to your associated provider arrangements.
You can choose to:
- connect with the API directly (self-implementing)
- nominate a third-party software operator to use the API for you.
If you connect through a third-party software operator, they can submit notifications on your behalf. But you still need to register with us and nominate the operator.
Before you start
Before you connect to the API, you need to check that you meet our eligibility and technical requirements.
Eligibility
To use the API, you must be a registered provider notifying us about changes to your associated providers.
Technical requirements
To connect to the API, you need:
- a system that can connect to a REST API, or a third-party software operator who can connect for you
- the technical ability to test your connection in our sandbox (test environment) before you go live.
What to expect
This is an overview of the steps from the API registration to submitting your first notification.
1. Register
Complete the Registration form and email it to us.
If you're connecting through a third-party software operator, nominate them in the form. They don’t need to register separately.
When you complete the form, you need to:
- acknowledge our API terms of use
- confirm that you conform with our:
- technical and API requirements, by testing
- security and operational requirements, by self-attesting (making a declaration).
2. Eligibility and identity check
We check that:
- you're eligible to use the API
- a person authorised to act for your organisation submitted your registration.
3. Connect and test in our sandbox
You, or your operator, authenticate and test your connection in our sandbox environment using test cases that cover the API's core operations. This is how you show that you conform with the API and technical requirements.
4. Submit your test evidence
We ask you to email us evidence that you’ve completed the test cases. We check the evidence and confirm that it meets our requirements to move to the production environment (to go live).
5. Get production access
We confirm that you’re eligible and you conform with the API requirements, then give you a Client ID for production access.
6. Start submitting, and keep us updated
You can now use the API to submit associated provider change-in-circumstance notifications in bulk.
If your circumstances change later (for example, if you change software operators), you must tell us. For some changes we may need to reassess your conformance.
How to register
Complete the Registration form and email it to APIRegistration@agedcarequality.gov.au.
We'll contact you to start the connection and testing process.
If you're connecting through a third-party software operator, nominate them in the Registration form. We’ll contact them to make the connection.
More information
Find more information on updates and how to get support with API.