API
Contents
Emersion API Infrastructure
Emersion has implemented an External API Framework Layer to assist in clients integrating directly into parts of the Emersion Eco-System.
Most additions to the framework to date have been directly from client requests, and Emersion is able to extend or add new functionality on a case by case and quoted basis.
For a quote on a solution to fit your requirement, please contact the Emersion Sales team.
For an individual or business looking to work with our API layer, we can recommend the freeware software Soap UI to perform testing and gain guidance on operations contained within the API.
This software allows you to view the methods contained within the API and send and receive test calls to the API without having to write a system.
There are two types of API currently supported by Emersion, one which is designed for Emersion customers to authenticate via SSL to perform administrative functions, and another where the end users of clients can authenticate (generally for use with SmartPhones) via a username and password to perform end user tasks. Please note access to the end user API is an add-on feature.
Provider Based API Functionality
Security Layer
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising SSL certificate as security. The SSL certificates are provided by Emersion, and may be subject to a professional services charge depending on your Emersion agreement.
The WSDL for each set of functions is documented in the next section.
For production, use; https://external.emersion.com.au/
For testing, use; https://external-prerelease.emersion.com.au/
NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code
Provider API Documentation
There are different API types, listed below;
Minimal - Basic Introductory Methods
Services - Mostly Service Centric Based Methods (most methods go here.)
Retail Services - User Based Information including Payment Integration
Reference Data for use within API calls
AAPT Specific Integration functions
End User Based API Functions
This is the API layer of which will be used to enable Emersion customers to have thin clients such as those of which are embedded on smart phones communicate with our platform directly for the purpose of information and self service.
Security Layer
To integrate with Emersion’s API Framework, clients will need to implement a SOAP Client, utilising a username and password which is embedded within the SOAP Body as security.
The WSDL for each set of functions is documented in the next section.
For production, use; https://to-be-advised.emersion.com.au/
For testing, use; https://to-be-advised-prerelease.emersion.com.au/
NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code
