SOAP Endpoints
The AlphaTrust® e-Sign Web Service APIs are the recommended interface for all integration and development activity.
SOAP-based Web Services in AlphaTrust® e-Sign have been implemented using Windows Communication Foundation, which can support more than Web-based (http-based) protocols.
WSDL
You may retrieve the WSDL for any service using one of two methods:
- use the "mexHTTP" protocol on the service address from your development environment (i.e. "Add a Service Reference" in Visual Studio), or,
- use a browser or other Web service tool against the “wsdl” retrieval service address.
Configuring Endpoints
Service endpoints are exposed at a virtual Web application root called ProntoNetServices-v5, normally located at https://esign.yourdomain.com/ProntoNetServices-v5/. For our SaaS service these are the endpoints:
SaaS Service SOAP endpoints:
Customer Sandbox environment (SOAP): https://uat.alphatrust.com/ProntoNetServices-v5/ProntoService.svc
Customer Production environment (SOAP): https://esign.alphatrust.com/ProntoNetServices-v5/ProntoService.svc
Endpoints are configured in the \AlphaTrust\Pronto4\ProntoNetServices-v5\web.config file in your installation. This web.config file is setup for non-production out-of-the-box. If you require SSL/TLS for your endpoints, please replace the web.config with the contents of the web-ssl.config file in the same directory.
Out of the box the standard configuration supports the following SOAP web service bindings:
basicHttpBinding
A WCF implementation of the WSI-Basic Profile 1.1. This is the most widely supported profile and can be consumed by the widest variety of platforms and clients, including those based on .NET, Java, Perl, and Python.
basicHttp — The standard binding for most API operations. Uses
Streamedtransfer mode with a 1-minute timeout and a maximum received message size of 16 MB. Choose this binding for typical requests such as creating transactions, adding participants, and querying status.
basicHttpLarge — A binding configured for large payload operations such as uploading or downloading documents. Uses
Bufferedtransfer mode with a 10-minute timeout and a maximum received message size of approximately 100 MB. Use this binding when sending or receiving large files to avoid timeout or message-size errors.
basicHttpMex — A metadata exchange endpoint used for service discovery. This is the binding that tools like Visual Studio's Add Service Reference use to retrieve the WSDL and generate proxy classes.
wsHttpBinding
An advanced binding that supports WS-* specifications including WS-Security, WS-ReliableMessaging, and WS-AtomicTransaction. Use wsHttpBinding when you need message-level security, reliable messaging, or transactional support beyond what basicHttpBinding provides.
wsHttp — The standard WS-* binding for most API operations. Configured with a 1-minute timeout and a maximum received message size of 16 MB. Choose this binding when your client requires WS-Security features such as message-level encryption or digital signatures.
wsHttpLarge — A WS-_ binding configured for large payloads with a 10-minute timeout and a maximum received message size of approximately 100 MB. Use this binding when you need both WS-_ security features and large document transfer.
Choosing the Right Binding
| Scenario | Recommended Binding |
|---|---|
| Cross-platform clients (Java, Python, Perl) | basicHttp |
| .NET clients with standard message sizes | basicHttp or wsHttp |
| Large document upload/download (> 16 MB) | basicHttpLarge or wsHttpLarge |
| Message-level security or WS-Security required | wsHttp or wsHttpLarge |
| Service discovery / WSDL retrieval | basicHttpMex or mexHttp |
If you do not have a specific requirement for WS-* features, use the basicHttp bindings. They offer the broadest client compatibility and lower overhead.
You should generally not edit the web.config file. For development purposes, when not using SSL, you will need to disable transport security on the endpoints. See the comments in the web.config file's <system.serviceModel> section for information on disabling transport security.
On-Premise Service Addresses (SOAP):
Assuming a web server address of esign.yourdomain.com, the service endpoint addresses would be as follows:
HTTP GET WSDL retrieval (Web browser address):https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc?singleWsdl
mexHttp address:https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc/mex
basicHttp (WSI-Basic 1.1 Profile) address:https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc/basicHttp
basicHttpLarge (large payload) address:https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc/basicHttpLarge
wsHttp (WS-* Profile) address:https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc/wsHttp
wsHttpLarge (WS-* large payload) address:https://esign.yourdomain.com/ProntoNetServices-v5/ProntoService.svc/wsHttpLarge
Creating a Proxy
If you are creating the proxy classes manually, you need only add them to your project. The Add Service mechanism in Visual Studio is used to automate this process and add the types in.
The wsdl executable will read the WSDL file that you reference and generate the proxy code.
For a Java proxy, you can follow their instructions found in their documentation.