FileCatalyst SDK

FileCatalyst provides a variety of integration options for third-party Independent Software Vendors (ISVs) to support accelerated file transfers within their products. The FileCatalyst SDK boasts a large number of components, development languages, and environments.

FileCatalyst can be integrated into any application/workflow with minimal coding and provides a full range of method calls with access to all common and advanced features.

Product APIs Available Usage
FileCatalyst Server Java, CLI, REST Administration of FileCatalyst Server (Example: Add/Remove Users, Manage Current Transfers
FileCatalyst Hotfolder REST Full Control of entire application (Example: Add new Site, Modify Scheduler, Change bandwidth)
FileCatalyst TransferAgent JavaScript, REST Integrate web transfers within any web application (Example: Get local/remote files, execute upload)
FileCatalyst Mobile Android, iOS, C++ Integrate accelerated file transfer within any mobile application
FileCatalyst Client API Java, C++, CLI, .NET Integrating into desktop applications
FileCatalyst Workflow Job Submission Java Integrate job submission/distribution into any application.
FileCatalyst Workflow Administration REST Integrate creation of  users, fields and forms
FileCatalyst Central REST Manage, Monitor entire FileCatalyst Deployment. Remotely control any connected node. Execute transfers remotely
FileCatalyst TransferController REST Integrate Node to Node Transfers into any application

*Transfer to and from Workflow.

The Development Kit is the foundation of our products; if you own any qualifying products, the Development Kit may be licensed as an add-on. For standalone development, the SDK is typically added on to FileCatalyst Direct; however, some components are designed to interact with FileCatalyst Workflow.

Watch Our Java SDK Webinar  

Download accompanying example source code here

Watch Our C++ SDK Webinar

Client API

TransferController – Integrated via the REST API, TransferController offers the ability to perform transfers between multiple nodes as a single process. The TransferController also provides real-time status on the transfer.

Java Client API – Provides methods for establishing a connection with a FileCatalyst Server, uploading and downloading files, and full control over ongoing transfers. Default values are used for common functions, but the API provides a full range of method calls for advanced features. The API also allows users to programmatically submit jobs and files to FileCatalyst Workflow.

Copy to Clipboard
Copy to Clipboard

C++ Native Client Library – A native C++ client API that is also available as a command-line executable. It allows FileCatalyst to be embedded on systems without Java. This API provides the same functions as the Java API, and can be compiled/used on platforms that do not support Java.

Copy to Clipboard

Server APIs (Java and REST) – Exposes every method needed to manage users, groups and virtual files/folders as well as request session information from a FileCatalyst Server.

Copy to Clipboard

Mobile APIs – Allows integration of fast file transfers within iOS and Android apps. FileCatalyst provides a native Objective-C API for iOS and a Java API for Android Dalvik. Built using these mobile APIs, the FileCatalyst app is also available for Android and iOS in their respective app stores.

Copy to Clipboard

HotFolder REST API – This API gives full control over any HotFolder instance.  It exposes methods that let you add new watch folders, new sites and create, manipulate, and execute tasks.

TransferAgent (JavaScript and REST API) – Enables tight integration of FileCatalyst within any web application. Web applications using TransferAgent are able to access/browse local file systems, add files to a queue, and initiate or monitor file transfers through JavaScript, or directly through REST calls.

Central REST API – Provides complete access to reporting data for all connected nodes. The API also acts as a reverse HTTP proxy to access the REST APIs of individual connected nodes such as Server, HotFolder and TransferAgent.

Command Line Tools (CLIs) – Provides interfaces that allow you to transfer files via a command line console, providing an easy scripting experience. Available in both JAVA and C++, these tools can be integrated into existing shell scripts that currently use FTP, SCP or rsync.