The ability to send files and directories as a package to a list of recipients is one of the features that Faspex offers.  The Faspex API allows developers to integrate this capability into their own applications.  This allows developers to build and send packages and offer confirmations messages and other services within their own applications.  This is easily accomplished with the API where you can simply encapsulate the common details into a JSON object that represents the Faspex package and send the package to the server for processing.

When using a Faspex server you can send files that are on your local machine; this is called local-to-remote package delivery, or send files that are on a remote server; this is called remote-to-remote package delivery.

Local to Remote Package Delivery

When performing local-to-remote deliveries the paths on the local host are included in the delivery section of the JSON.  An example of this request is seen below.

 

This is sent as POST to the endpoint /aspera/faspex/send, which states the upload but does not trigger it.  You will need to trigger the actual transfer of the package from the client's host to the faspex server.  The response received will contain the section xfer_sessions which will include all of the information you need to start the transfer.  The actual transfer will need to be performed either using the FASPManager SDK, Connect API or your preferred transfer method.  An example of this response is seen below.

 

Remote to Remote Package Delivery

When performing remote-to-remote delivers the ID of the remote server and the paths on the remote server need to be included in the delivery section of the JSON.  If you do not provide an ID of the remote server the operation is assumed to be a local upload from the client's host.  An example of this request is seen below.

 

This is sent as POST to the endpoint /aspera/faspex/send.  If you wish to test this you can use the following cURL example:

curl -k --basic -uadmin:aspera -H "Content-Type: application/json" -H "Accept: application/json" -X POST https://10.0.160.5/aspera/faspex/send -d '{"delivery": {"title": "CorporateSummit","note": "Materials for the summit","recipients": [ "director", "external@email.com" ],"send_upload_result": true,"use_encryption_at_rest": false,"metadata": {"Name": "Summit","Menu": "Option"},"sources": [{"paths": ["presentation.ppt"]}]}}'

In remote-to-remote deliveries the faspex server and remote server negotiate and starts the upload without any other implementations.  The response only contains a link that you can follow to get the status of the package.  An example of this response is seen below.

 
Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×