Difference between revisions of "API"
(→Provider Based API Functionality) |
(→Provider Based API Functionality) |
||
| Line 17: | Line 17: | ||
== Provider Based API Functionality == | == Provider Based API Functionality == | ||
| + | Fees may apply to have these configured, activated and maintained | ||
| + | |||
| + | If you are interested in subscribing to an optional module, please raise a new sales ticket by email to sales@emersion.com.au | ||
| + | |||
| + | There are a number of Sets of API's and these | ||
=== Security Layer === | === Security Layer === | ||
| Line 28: | Line 33: | ||
For the UAT API layer use; https://uat1-external.emersion.com.au/ | For the UAT API layer use; https://uat1-external.emersion.com.au/ | ||
| − | === Basic API Set === | + | === Basic Provider Based API Set === |
These API Calls are included in the Basic API Set. | These API Calls are included in the Basic API Set. | ||
| − | === CRM API Set === | + | === CRM API Set === |
| − | These API Calls are an Optional subscription | + | These API Calls are an Optional subscription. |
| + | Fees apply to have these configured, activated and maintained. | ||
=== Signup API set === | === Signup API set === | ||
| + | These API Calls are an Optional subscription. | ||
| + | Fees apply to have these configured, activated and maintained. | ||
=== Provider API Documentation === | === Provider API Documentation === | ||
| Line 55: | Line 63: | ||
=== User Portal API Set === | === User Portal API Set === | ||
| + | These API Calls are an Optional subscription. | ||
| + | Fees apply to have these configured, activated and maintained. | ||
| + | |||
[[API/UserPortal|User Portal based methods]] | [[API/UserPortal|User Portal based methods]] | ||
=== Service Category Specific API sets === | === Service Category Specific API sets === | ||
| + | These API Calls are an Optional subscription. | ||
| + | Fees apply to have these configured, activated and maintained. | ||
| + | |||
[[API/AAPT|AAPT Specific Integration functions]] | [[API/AAPT|AAPT Specific Integration functions]] | ||
Revision as of 16:11, 8 June 2016
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 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 or Certificate based API is an add-on feature and API Calls may be broken into sets with differing Setup and Ongoing Fees per set.
For a quote on a solution to fit your requirement, please contact the Emersion Sales team.
Provider Based API Functionality
Fees may apply to have these configured, activated and maintained
If you are interested in subscribing to an optional module, please raise a new sales ticket by email to sales@emersion.com.au
There are a number of Sets of API's and these
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 and access fee 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 the UAT API layer use; https://uat1-external.emersion.com.au/
Basic Provider Based API Set
These API Calls are included in the Basic API Set.
CRM API Set
These API Calls are an Optional subscription. Fees apply to have these configured, activated and maintained.
Signup API set
These API Calls are an Optional subscription. Fees apply to have these configured, activated and maintained.
Provider API Documentation
There are different API types, listed below;
Minimal - Basic Introductory Methods
Account - Account Management Based Methods
Plans - Package Plan Management Based Methods
Products - Products Management Based Methods
Services - Mostly Service Centric Based Methods
Retail Services - User Based Information including Payment Integration
Reference Data for use within API calls
User Portal API Set
These API Calls are an Optional subscription. Fees apply to have these configured, activated and maintained.
Service Category Specific API sets
These API Calls are an Optional subscription. Fees apply to have these configured, activated and maintained.
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 simple/basic HTaccess authentication - the end user username and password is what is used.
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/
If you have UAT access, it is via http://api-uat.emersion.com.au/Account.wsdl
NOTE: Please contact Emersion before you begin testing on Pre-Release to ensure the environment is stable and not using any test code
API Documentation
Code Samples
You can use these samples as a starting point in you implementation.
Please note that certificate files are placeholders.
They need to be replaced by real certificates to make the code work.
