Revision as of 09:20, 7 October 2016

Emersion APIs

Emersion has a comprehensive set of APIs to assist in clients integrating directly into parts of the Emersion ecosystem.

Most APIs have been created as a result of collaborative efforts with our clients. Emersion is happy to consider extending or add new functionality on a case by case basis.

There are two types of APIs currently supported by Emersion:

• SSL certificate - Emersion users authentication via SSL certificate to perform administrative functions
• Username / Password Authentication - End users of can authenticate via a username and password to perform end user tasks. This can be used to build custom interfaces, and give end users the ability to retrieve their information and self-manage their accounts such as via smart phones apps.

Access to the APIs is via subscription. API calls are be broken into sets with set up and monthly access / usage fees applying per set. 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 APIs, we 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.

Use Case Scenarios

These articles aim to assist developers understand various workflows and corresponding dependencies when using the APIs to perform tasks for a process.

• Onboarding a new customer & ordering services

Provider Based API Functionality (Certificate Based)

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

For clarification on what is covered in your contract please contact Emersion.

Security and Access Controls

To integrate with Emersion’s API Framework, clients will need to implement a SOAP client that utilises an SSL certificate as security. The SSL certificates for provider-based APIs are provided by Emersion.

Provider-level APIs

For Production, use; https://external.emersion.com.au/ For UAT, use; https://uat1-external.emersion.com.au/

End-User APIs

Please contact the Emersion Sales department for the URLs to use for end user APIs.

APIs for Service Providers

These APIs use an SSL certificate to authenticate.

• Minimal - Basic introductory methods
• Reference data for use within API calls

Advanced APIs for Service Providers

• Account - Account based methods
• Retail services - User based information including payment integration

Customer Signup APIs for Service Providers

• Services - Service centric based methods
• Orders - Order based methods

Products APIs

• Products - Product based methods

Package Plan APIs

• Plans - Package plan based methods

End User Portal APIs

• User Portal based methods

Service category-specific APIs

• AAPT Specific Integration functions

End User APIs

These APIs use a username and password to authenticate.

• End User API

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.

• C#