The Aspera Web Services Interface is a key component of all Aspera Servers and Point to Point Products. The Web Service Interface allows other applications, local or over a network; to initiate, monitor and control transfers. You can learn more about SOAP Web Services by viewing the Introduction video. These tasks can easily be accomplished and this section will explain how to complete these tasks. An overview of these Web Services is shown below:
- Initiating Transfers can be accomplished by simply submitting an XML string describing the transfer parameters.
- Monitoring Transfers can be accomplished in a local or remote application that can subscribe for all events or specific ones as defined by the developer. The topics available to subscribe to include: session start, stop, status, error. Your application will receive notifications in the form of a Web Service call with the requested data. If you prefer you can also submit a query for current status.
- Controlling Current Transfers can be accomplished by resubmitting parameters with your new configuration or sending a pause, resume or cancel command.
The Aspera Web Services Interface is comprised of three main web services:
- JobNet which allows the initiation of FASP transfers.
- IScpTransferNet which provides job level event notifications and supports querying for job level statistics, where a 'job' represents a transfer task that was requested by the user.
- FASPSessionNet which provides session level event notifications and querying for session level statistics, where a 'session' represents an actual FASP transfer instance.
It is important to note that a job starts a session which transfers the files and if a session encounters an error and stops the same job will start a second session to get the files transferred.
The asperacentral service provides the SOAP based API's. By default the service runs in the background as a daemon. For debugging purposes, you may run the service in "no-daemon" mode and print out the logs to the console. On Linux you can stop the asperacentral service with the following command:
To start the service in "no-daemon" mode for debugging you can run the following command:
/etc/init.d/asperacentral --no-daemon -DDD -L-
To help demonstrate this flow of events a detailed diagram is seen below: