Difference between revisions of "API"
(→Service category-specific APIs) |
(→Emersion APIs) |
||
| Line 1: | Line 1: | ||
| − | = | + | {{DISPLAYTITLE:SOAP APIs}} |
| + | = Overview = | ||
| − | Emersion | + | Emersion provides programmatic access to your organisation’s information using simple, powerful and secure application programming interfaces. 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. |
| − | + | The Emersion SOAP API lets you integrate applications that can create, retrieve, update records managed by Emersion. Records such as accounts, services, package and service plans and other objects. With more than 70 different calls with the numbers predicted to climb, SOAP API also lets you to maintain passwords, perform searches and much more. You can use the SOAP API with any programming language that supports Web services. | |
| − | There are two | + | Access to the APIs is via subscription only. For a quote to fit your requirements, please raise a Quote Request ('QR') ticket in the Emersion Support Portal or contact our Sales department. |
| + | |||
| + | API calls are broken into sets with set up and monthly access / usage fees applying per set. | ||
| + | |||
| + | There are two authentication methods Emersion currently used to provide access to the APIs. | ||
* '''SSL certificate''' - Emersion users authentication via SSL certificate to perform administrative functions | * '''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. | * '''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. | ||
| − | + | == Testing APIs == | |
| − | + | Emersion does not provide a Sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, Emersion recommends using the freeware client [https://www.soapui.org/|Soap UI] to perform testing and setting up some test/dummy accounts to work with. Soap IU allows you to view the methods contained within the API and learn the strucvture of a request and a response without having to write to a system. | |
| − | |||
| − | |||
| − | |||
== Use Case Scenarios == | == Use Case Scenarios == | ||
Revision as of 15:58, 6 January 2017
Overview
Emersion provides programmatic access to your organisation’s information using simple, powerful and secure application programming interfaces. 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.
The Emersion SOAP API lets you integrate applications that can create, retrieve, update records managed by Emersion. Records such as accounts, services, package and service plans and other objects. With more than 70 different calls with the numbers predicted to climb, SOAP API also lets you to maintain passwords, perform searches and much more. You can use the SOAP API with any programming language that supports Web services.
Access to the APIs is via subscription only. For a quote to fit your requirements, please raise a Quote Request ('QR') ticket in the Emersion Support Portal or contact our Sales department.
API calls are broken into sets with set up and monthly access / usage fees applying per set.
There are two authentication methods Emersion currently used to provide access to the APIs.
- 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.
Testing APIs
Emersion does not provide a Sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, Emersion recommends using the freeware client UI to perform testing and setting up some test/dummy accounts to work with. Soap IU allows you to view the methods contained within the API and learn the strucvture of a request and a response without having to write to 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.
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.
Advanced APIs for Service Providers
- Account - Account based methods
- 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.
