Why use the API?
By using the API you can:
What you can achieve
Synchronise: Remove the requirement to manually export and import data between systems by synchronising your community information through the Community Information Exchange.
Integrate: Confirm a user is an employee or volunteer with a community or health service organisation without having to maintain your own database of users and organisations.
Create: Automatically create directory listings and events for broad publication. Improve the visibility of your services and drive traffic to your own website.
Intelligence: Discover what needs are not being met within the community based on behavioural analytics of the broad base of users leveraging the Community Information Exchange.
What you need to know
Access to the Community Information Exchange may be subject to costs depending on your intended use.
By using the API you can:
- create efficiencies by integrating disparate systems
- save time by automating repetitive and laborious tasks
- reduce the potential for human error.
What you can achieve
Synchronise: Remove the requirement to manually export and import data between systems by synchronising your community information through the Community Information Exchange.
Integrate: Confirm a user is an employee or volunteer with a community or health service organisation without having to maintain your own database of users and organisations.
Create: Automatically create directory listings and events for broad publication. Improve the visibility of your services and drive traffic to your own website.
Intelligence: Discover what needs are not being met within the community based on behavioural analytics of the broad base of users leveraging the Community Information Exchange.
What you need to know
- The API is a tool for programmers.
- The API is a RESTful architecture and based on sharing JavaScript Object Notation (JSON) information.
- The API does not provide direct access to the data within the Community Information Exchange.
- Access to information is filtered based on your products permissions combined with those of the ultimate end user. You may not have access to certain fields and records within the Community Information Exchange.
- Some information held in the Community Information Exchange is provided based on restrictive agreements held with third parties. To access this information you may need to agree to additional terms and conditions or enter into a formal agreement with the custodian of the information.
- Your usage of the Community Information Exchange is monitored.
- You may be required to provide non-personally identifiable metrics of usage by the end users of your product as part of your commitment to improve the Community Information Exchange.
Access to the Community Information Exchange may be subject to costs depending on your intended use.