Difference between revisions of "API"
(→Security Layer) |
(→Provider Based API Functionality (Certificate Based)) |
||
| (36 intermediate revisions by 5 users not shown) | |||
| 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. | |
| + | 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. | |
| − | + | Authentication is handled via a username and password. Some Emersion customers use an SSL certificates to authenticate, but this authentication method is now deprecated. | |
| − | |||
| − | + | == Testing APIs == | |
| + | Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, [https://resources.emersion.com/display/EKB/Testing+the+APIs+using+SoapUI refer to this article]. | ||
| − | + | == 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. | ||
| + | |||
| + | * [[API/UseCases/ServiceOrders| Onboarding a new customer & ordering services]] | ||
== 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 | ||
| − | + | 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 a WSSE header for authentication. | ||
| − | + | === Provider-level APIs === | |
| + | For Production, use; https://api.emersion.com.au/ | ||
| − | == End User | + | === End-User APIs === |
| + | Please contact the Emersion Sales department for the URLs to use for end user APIs. | ||
| − | + | = APIs for Service Providers = | |
| + | * [[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]] | ||
| − | + | == Customer Signup APIs for Service Providers == | |
| + | * [[API/Services|Services - Service centric based methods]] | ||
| + | * [[API/Orders|Orders - Order 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 = |
* [[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. | ||
Latest revision as of 09:46, 16 January 2020
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.
Authentication is handled via a username and password. Some Emersion customers use an SSL certificates to authenticate, but this authentication method is now deprecated.
Testing APIs
Emersion does not provide a sandbox environment for APIs. To gain experience and guidance on the operations contained within an API, refer to this article.
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
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 a WSSE header for authentication.
Provider-level APIs
For Production, use; https://api.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
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
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.
