The Aspera Faspex API is divided into two versions.  API v. 3 (corresponding to Faspex v. 3.9.3 and below) provides a set of RESTful web services that enable you to create and receive digital deliveries with a web interface while using FASP® technologies.  It supports JSON objects, creating packages from remote data sources, and submitting packages to dropboxes.

The lastest-generation API, Faspex API v. 4, has a pure REST architecture.  API v. 4 became available with Faspex 4.0.0 and became fully-featured for Faspex 4.1.0.  It adds support for SAML configurations, OAuth authentication, and offers comprehensive management for dropboxes, workgroups, and packages.

Authentication

Calls with the Faspex API use basic HTTP authentication.  Faspex returns a HTTP response code of 401 Unauthorized for any request that does contain valid credentials.  The only factor that confirms successful authentication is the HTTP response code; while some services may return data in the body of the response concerning the failure, that information is generally ignored by the client.

Addressing Packages

For the purpose of addressing packages to recipients Faspex users are identified by their username.  If the recipient is an external user (not in the address book) they will be identified by their email address.  While older versions of Faspex required usernames to be in a user@host format, that is no longer required.

Notification Emails

You can configure Faspex so that you are notified about successful upload or download of the file by the recipient.  These notification emails contain a custom SMTP header that contains the link to retrieve the package information in XML format.  For example:
X-Aspera-Filepkg-Location: https://10.0.123.456:443/aspera/faspex/received/78"

Error Responses

HTTP status codes are returned with the JSON response; as long as the status code is 200 or 201 everything has completed successfully.  However, error codes may also be returned; the most common is a 401 "not authorized" error. Other common error codes are the following:

  • 404 No Content - Package not found; returns an error object
  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 500 HTTP Internal Server Error - Request is valid but the server encountered an error; returns an error object
Video player

Video

×