What is CoreAPI?

CoreAPI refers to the middleware being increasingly used within the Synergetic product suite.

This is a required element for all installs from v68 onwards.

While predominantly in the web space this is also used in the Windows application, notably for address validation.

What are the requirements to use CoreAPI?

Clients will need to provision a DNS entry that is able to be resolved by all users of the Synergetic application.

This requirement will be identified to you procedurally, and the entry will be something like syncoretest.school.edu.au and needs to point to the IP address of the internal server being used.

These entries will subsequently be configured by our team on your IIS instance.

Which parts of the Synergetic CoreAPI may need to be publicly accessible?

(e.g. For specific firewall filtering)

The public and private APIs are self documented in the actual CoreAPI and a list can be obtained by accessing https://yourcoreapiurl/Help then expanding each heading to view the APIs.

It is recommended to limit external access based on endpoint URLs, for example https://yourcoreapiurl/api/AddressValidation/* if only needing to use Address Validation tools (QAS).

Where is CoreAPI documentation?

Further documentation can be found at https://developer.synergetic.net.au/api.html

Can clients access the CoreAPI web service calls?

Yes, details around the process for providing access to the APIs for external consumption are documented at https://developer.synergetic.net.au/index.html