Aspera Faspex

Introduction

IBM Aspera Faspex is a centralized transfer solution that enables users to exchange files with each other using an email-like workflow. Faspex enables high-speed transfers using IBM Aspera’s proprietary FASP protocol, fully utilizing available network bandwidth to maximize speed while preserving control and security. User-uploaded files and folders are sent to, stored on, and downloaded from Aspera transfer servers.

You can find more details and the supported operations at Aspera Faspex | qibb Catalog.

How to get started with Aspera Faspex integration

Before you get started with Aspera Faspex integration, please make sure that you have the needed permissions for those operations.

1. Get a Client ID associated with your account in the Aspera Faspex UI. You can get it or create a new one under Configurations > API clients.

2. Go to qibb Workflow Editor, open Node Catalog in the right sidebar, and install Aspera Faspex node by clicking on the + button.

3. Drag the Aspera Faspex auth node to the grid and configure the required inputs.

   1. Server URL: The Aspera Faspex Server instance URL where it is running.

   2. Client ID: It can be generated from the Aspera Faspex UI under Configurations > API clients.

   3. Private Key (RSA): Application users should have their user-specific key entered into their account under Account settings > Preferences > Public key.
      In order to generate an RSA Key pair, please follow these instructions and then add the public key to the desired account.

   4. User Email: This is the Aspera Faspex email account which is associated with the Private RSA key added in the previous step.

   5. App Redirect URL: The URL to redirect the user(s) after successful authentication.

   6. Expiration Time: Optional expiration time for the access token generated after being authenticated successfully. 2h by default.

4. Drag the Aspera Faspex API node and any other nodes that you require from the left sidebar to your flow and connect them. Now you can start using the integration!

   

Importing flow examples of a node

Once you've successfully installed a node from the qibb catalog, you can easily import example flows that showcase how the nodes can be used. These example flows are directly accessible within the Flow Editor and are designed to guide users with helpful hints, including how to configure mandatory parameters and credentials.

Here's how to import examples:

1. In the top right corner of the Flow Editor, click on the menu icon.

2. Select Import to open the Import Dialog.

3. Click on the Examples tab.

4. Choose an example from the list.

5. Confirm your selection by clicking on the Import button.

By following these steps, you are now ready to make basic API calls using the provided examples. For further exploration of what’s possible, you can find more complex examples in the Flow Catalog.