Difference between revisions of "API"
From Emersion
(→Provider Based API Functionality (Certificate Based)) |
(→Emersion API Infrastructure) |
||
| Line 1: | Line 1: | ||
| − | = Emersion | + | = Emersion APIs= |
| − | Emersion has | + | Emersion has a comprehensive set of APIs to assist in clients integrating directly into parts of the Emersion ecosystem. |
| − | Most | + | 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: | ||
| − | + | * Emersion users authentication via SSL certificate to perform administrative functions | |
| + | * 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. | ||
| − | 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 | + | Access to the APIs is via subscription. API calls may be broken into sets with set up and monthly access fees applying per set. 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. |
| − | |||
| − | |||
| − | |||
| − | |||
For a quote on a solution to fit your requirement, please contact the Emersion Sales team. | For a quote on a solution to fit your requirement, please contact the Emersion Sales team. | ||
| − | == Provider Based API Functionality (Certificate Based)== | + | == Provider Based API Functionality (Certificate Based) == |
| − | Fees may apply to have these configured, activated and maintained | + | 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 |
| − | 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. | 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 | + | 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 are provided by Emersion | + | The SSL certificates are provided by Emersion. |
| − | |||
The WSDL for each set of functions is documented in the next section. | The WSDL for each set of functions is documented in the next section. | ||
| Line 34: | Line 28: | ||
For the UAT API layer use; https://uat1-external.emersion.com.au/ | For the UAT API layer use; https://uat1-external.emersion.com.au/ | ||
| + | === Security Layer === | ||
| − | + | 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 | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | = APIs for Service Providers = | |
| + | These APIs use an SSL certificate to authenticate. | ||
| + | * [[API/Minimal|Minimal - Basic introductory methods]] | ||
| + | * [[API/Reference|Reference data for use within API calls]] | ||
| − | == | + | == Advanced APIs for Service Providers == |
| − | + | * [[API/Account|Account - Account based methods]] | |
| − | + | * [API/RetailServices|Retail services - User based information including payment integration]] | |
| − | [[API/ | + | == Customer Signup APIs for Service Providers == |
| + | * [[API/Services|Services - Service centric based methods]] | ||
| − | == | + | == Products APIs == |
| + | * [[API/Products|Products - Product based methods]] | ||
| − | + | == Package Plan APIs == | |
| + | * [[API/Plans|Plans - Package plan based methods]] | ||
| − | == | + | == End User Portal APIs == |
| − | + | * [[API/UserPortal|User Portal based methods]] | |
| − | + | == Service category-specific APIs == | |
| + | * [[API/AAPT|AAPT Specific Integration functions]] | ||
| − | + | = End User APIs = | |
| − | + | These APIs use a username and password to authenticate. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* [[API/EndUser|End User API]] | * [[API/EndUser|End User API]] | ||
| − | |||
| − | + | = Code Samples = | |
You can use these samples as a starting point in you implementation. | You can use these samples as a starting point in you implementation. | ||
Revision as of 09:24, 27 June 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:
- Emersion users authentication via SSL certificate to perform administrative functions
- 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 may be broken into sets with set up and monthly access fees applying per set. 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.
For a quote on a solution to fit your requirement, please contact the Emersion Sales team.
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 are provided by Emersion.
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/
Security Layer
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
APIs for Service Providers
These APIs use an SSL certificate to authenticate.
Advanced APIs for Service Providers
- Account - Account based methods
- [API/RetailServices|Retail services - User based information including payment integration]]
Customer Signup APIs for Service Providers
Products APIs
Package Plan APIs
End User Portal APIs
Service category-specific APIs
End User APIs
These APIs use a username and password to authenticate.
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.
