With IBM Aspera applications and SaaS offerings, you can securely explore file systems and move data at maximum speed, regardless of file size, transfer distance, or network conditions.

Aspera offers a suite of APIs that enable you to integrate Aspera into your own applications, accommodate hybrid-cloud storage systems, and meet transfer needs. You can transfer to and from the cloud or on-premises nodes, and transfer files or streams.

Note: The Aspera API documentation is hosted in two locations—the Developer Community and the Aspera Developer Community—as the documentation is moved into the Developer Community. The Developer Community has the most up-to-date information about the APIs; the links in the following article point to the best reference.

What is a Node?

Before delving into the capabilities of Aspera APIs, we need to define node. A node is any Aspera server that is configured to use the Node API, which is the API that is used to manage and monitor node activity, including transfers. Aspera nodes include SaaS and self-managed Aspera applications, such as Aspera on Cloud, IBM Aspera High-Speed Transfer Server, and Aspera on Cloud transfer service.

For more information about nodes, see Getting Started with the Node API.

What Aspera APIs are available?

 
API Description
Android SDK A Java API to integrate Aspera FASP transfers in your Android applications.
Activity API A REST API that provides all the functionality of the Activity App in Aspera on Cloud. Get detailed performance, history, and usage data for file transfers.
ATS API A REST API for the management of transfer credentials for your own cloud storage, through the Aspera on Cloud transfer servrice.
Automation API A REST API that provides all the functionality of the Automation App in Aspera on Cloud. Create automated workflows that initiate file transfers, make calls to an API, send notifications to users, and more.
Connect Client A JavaScript API that enables you to develop a native feel to your web applications while utilizing the Aspera file-transfer capabilities of IBM Aspera Connect.
Console API A REST API that allows you to start, manage, and monitor transfers across your Aspera ecosystem with the features of IBM Aspera Console.
Faspex Client SDK for Java An easy-to-use tool to use the Faspex RESTful API for integrating the package delivery and notification features of IBM Aspera Faspex into your application.
FASPStream SDK An SDK available for .NET, C/C++, and Java, that enables you to integrate high-speed stream-to-stream, file-to-stream, and stream-to-file transfers with your application.
Files API A REST API that provides all the security and functionality of Aspera’s premier SaaS offering, Aspera on Cloud.
iOS SDK An Objective-C API to integrate Aspera FASP transfers in your iOS applications.
Node API A REST API that enables complete management of Aspera transfers and servers (nodes).
Reliable Query API A REST API used to get information about transfers that are started by IBM Aspera Connect or Faspex.
Shares API A REST API that offers integration with IBM Aspera Shares node-to-node and node-to-web client file sharing.
Watch Folders API A REST API that allows to you automate node-to-node transfers that are triggered when content is added to a “watched” folder.

Which Aspera API to use?

 
Action API to use
Start and manage transfers
  • For node-to-node transfers, use the Node API.
  • To integrate an Aspera client application directly into your website, allowing users to transfer to and from your server without a stand-alone application, use the Connect Client.
  • To manage transfers through email, use the Faspex Client SDK for Java.
  • To stream content using Aspera high-speed transfer technology, use the FASPStream SDK.
  • To create automated workflows that transfer files and folders, use the Automation API.
Stream content
  • To stream content using Aspera high-speed transfer technology, use the FASPStream SDK.
Automate node-to-node transfers
  • To automatically transfer files from one node to another, triggered by adding files and folders to a specific folder on a node, use the Watch Folders API.
  • To create automated workflows that transfer files and folders, use the Automation API.
Monitor transfer activity
  • To monitor transfers that are started by a Node API request and other activity on a node, such as filelocking, changes to the file system, and permissions, use the Node API.
  • To monitor transfers that are started through IBM Aspera Faspex or Connect Client, use the Reliable Query API to interface with the Aspera Central service on an Aspera node.
  • To monitor usage of Aspera on Cloud, sorted by workspace and node, use the Files API
  • If you are integrating with IBM Aspera Console, track transfer activity across all attached nodes by using the Console API.
  • To monitor transfer performance and usage between endpoints within Aspera on Cloud, use the Activity API.
Integrate Aspera with your mobile app
Integrate with a specific Aspera application
  • To integrate all of the security and functionality of Aspera’s premier SaaS offering, Aspera on Cloud, use the Files API.
  • To create and transfer packages with an intuitive email workflow, use the Faspex Client SDK.
  • To integrate the content sharing features of IBM Aspera Shares, use the Shares API.
  • To monitor a network of nodes and launch transfers between them, use the Console API.
  • To create automated workflows with all the functionality of the Automation app in Aspera on Cloud, use the Automation API.
  • To monitor transfer performance and usage with all the functionality of the Activity app in Aspera on Cloud, use the Activity API.
Manage storage access and content permissions
  • To create and manage access keys, and assign content permissions, use the Node API.
  • To manage user access and roles for Aspera on Cloud, use the Files API.
  • To create and manage access keys for Aspera on Cloud transfer service, use the ATS API.
Browse file systems
  • To browse file systems on Aspera nodes, use the Node API.
  • To browse files in an Android application, use the Android SDK.
  • To browse files in an iOS application, use the iOS SDK.