eVapt Webservice APIs enables external systems to interact with eVapt. The external systems may be any of the following:
Payment systems such as banks and ATMs which require informing about the payment to the billing system
VoD servers that provide an ordering mechanism and need to check the available limits in the billing system
IVRS and SMS systems integrated with billing system
Handheld device integration
Selfcare portal developed by the service provider
SaaS portals can use eVapt APIs for registering customers, capturing contracts, and to handle Billing, Payments, and Followup activities, instead of building a Subscription Management and Billing system for their portal.
eVapt APIs use SOAP and XML over http. Every webservice expects a SOAP header that contains the security token called UserNameToken consisting of the UserId, Password, and ExternalPartyName. UserId and Password are the credentials of a user that is registered in eVapt. ExternalPartyName is the name of the external party that is integrating with eVapt, and should be registered in eVapt.
Each API expects the associated input object and a Reference number. Each API has a different input object. The Reference number is a unique id that the external system must send along with the request. If the API is called at any time again with the same reference no, the original response is returned with processing the request again.
Each API returns a Response object which contains the Transaction number, error number, and a message. Transaction number is the unique identifier generated in eVapt associated with each request.
Each API has an associated privilege code. The eVapt user that is used in the webservice client should be assigned the required privilege to call the API.
The APIs provided by eVapt to integrate with external system are mentioned in this document with Description, Request XML Format, Response XML Format, and Error numbers and their description.