Scaleflex DAM allows you to interect with the DAM using APIs.

The milestone events, descriptions, and dates are shown below.

Customers with active Support contracts will continue to receive support from the Scaleflex Support, per the terms and conditions specified in the support contract.

In order to avoid any inconvenience or disruption of Services, we recommend to our Customers having implemented the Filerobot Widget v2 to migrate to the v3.

Status

• Phase 1 - migration plan layout, no new features developed for v2 (until February 1st, 2023)

• Phase 2 - POCs and final version (until August 1st, 2023)

• Phase 3 - v2 no longer supported (September 30, 2023)

Step by step tutorial

All Widget functions and APIs for v2 version should remain compatible, however some advanced and new features will not be available unless the Widget used in the custom implementation is migrated to v3.

Be aware that no further developments will be published for the v2 Widget version, from February 1st 2023.

Please refer to the relevant NPM repository for more detailed instructions: LINK

First, what is actually a Headless DAM?

A Headless DAM helps decouple the creative process from the workflows required to publish media asset on the web and mobile. For example, creative teams or app users will feed media assets into Filerobot via the VXP HUB or the Media Asset Widget (MAW), while developers will use Headless DAM capabilities to publish the media assets on the target web or mobile applications.

A headless DAM is a DAM that allows the creation of custom frontends or galleries to provide an integrated upload experience or display media asset galleries in flexible ways.

A Headless DAM integrates well in a composable architecture, for example for an E-Commerce project with an ERP, a PIM and a CMS.

Benefits of a Headless DAM

A Headless DAM enables publishers on various channels to upload, process, and publish digital assets with the least amount of work and maximum effectiveness. Headless DAM is one of the finest options for brands and companies who wish to distribute massive volumes of digital assets across numerous platforms.

With customizable user interfaces, cross-platform data exchange, and streamlined workflows, Headless DAM offers users a quick and fast way to manage their digital assets.

The CLI is a command-line interface tool designed to interact with the DAM API. It enables server-side use and provides a convenient way to perform various operations on digital assets, such as uploading, downloading, deleting, moving and renaming files. Additionally, it allows users to list and query asset information, including tags and metadata.

The DAM CLI provides all the functionality of DAM and its APIs. It can be used from the terminal or in a script to access the features of Scaleflex DAM in a convenient way. Using the tool, all media assets can be managed via simple commands on macOS or Linux.

For example, you can perform Admin and Upload API operations by typing commands directly into a terminal. This saves you time as you do not need to set up a development environment. You can also build scripts with multiple CLI commands to implement more complex processes and workflows.

Complete documentation of the tool is available on its GitHub page:

What follows is a brief introduction and a quick-start guide to get you up to speed in no time.

Use cases and features

The DAM CLI provides a range of use cases that demonstrate its versatility:

• Bulk upload - Upload a large number of assets to the DAM in a single command, saving time and effort;

• Automated workflows - Incorporate the CLI application into server-side scripts or workflows to perform scheduled asset management tasks;

• Asset manipulation - Rename, move or delete assets based on specific criteria;

• Metadata management - Query and update asset metadata;

• Backup and recovery - Download assets from the DAM for backup or recovery purposes;

• Integration with other systems - Integrate the CLI into third-party tools or systems for seamless asset management.

The features of DAM CLI include:

• Uploading/Downloading multiple assets;

• Batch asset deletion;

• Listing assets;

• Querying asset information such as metadata, tags, etc.;

• Moving assets between folders;

• Renaming assets.

The following DAM APIs are supported: Delete, Download, Inspect, List, Move, Product, Rename and Upload.

Complete information about the Filerobot API endpoints is available in an always up-to-date documentation, that can be accessed via the following link:

There, you can find details about the API endpoints, together with all required request parameters, so you know how to interact with them.

Installation

Filerobot API can be installed by running one of the following commands depending on your operating system. They download the latest release of the tool from the GitHub page, move it to an appropriate directory and make it available for use.

MacOS

sudo curl -L "https://github.com/scaleflex/filerobot-cli/releases/latest/download/filerobot-cli-darwin-x86_64" -o /usr/local/bin/filerobot && sudo chmod +x /usr/local/bin/filerobot

Linux

sudo curl -L "https://github.com/scaleflex/filerobot-cli/releases/latest/download/filerobot-cli-linux-x86_64" -o /usr/local/bin/filerobot && sudo chmod +x /usr/local/bin/filerobot

You can confirm that the installation was successful by running:

filerobot version

The version of the tool should appear on the screen:

Filerobot CLI v. 1.5.0

Configuration

Configuring the CLI requires a DAM Token (mytoken) and API Secret Key (mysupersecretkey) both of which are available from the Filerobot Asset Hub.

filerobot config --token=mytoken --key=mysupersecretkey

Usage

The following commands are available:

Additional info for any command can be accessed using filerobot [command] --help.

Examples

Inspect the current token and key:

filerobot config -i

List the contents of a directory:

filerobot list /test

Inspect a specific resource:

filerobot inspect bb1ce06f-2677-581a-85e7-28c00ec50000

Download a file by UUID:

filerobot download bb1ce06f-2677-581a-85e7-28c00ec50000

Upload a file to a specific folder:

filerobot upload face.png --folder=/Marketing

Upload all .jpg images in the current directory:

for i in *.jpg; do filerobot upload $i -f /cli/upload; done

The MAW is a file uploader and media gallery in one easy-to-integrate modal or inline widget. It is the storefront of the DAM and enables accelerated uploads through DAM's content ingestion network and reverse CDN.

To use the DAM API, you will need to create an API key from Settings > Project > Access > API keys. This API key must be passed as X-Filerobot-Key header in all API requests.

Each API key is associated with a set of permissions that define the actions it is authorized to perform within the system.

See the developer's collection on Postman: Scaleflex DAM Authentication

Installation

Installing the MAW library happens over .

Modules

The MAW consists of the package and additional modules described below. The modules marked as required must be imported for the FMAW to function.

Code examples

Features

Some of the key capabilities of the Widget are:

• Single and multi-file uploads into the DAM

• Optimized for mobile

• Upload via Drag & Drop or Copy & Paste

• Upload from 3rd party storages such as Google Drive, Dropbox, OneDrive, Facebook, Instagram

• Webcam and screencast integration to upload real-time videos and screen recordings

• File explorer and media gallery with file management capabilities (folder creation, file move, rename, ...)

• Zipped download of multiple files

• File versioning with history, version browsing

• File and media asset sharing via accelerated CDN links

• Media gallery with powerful search capabilities based on tags and customizable metadata (taxonomy)

• AI-based tagging of images

• Embedded Filerobot Image Editor for inline image editing

• Image annotator and comments for collaboration

• Image variant generator with customizable template to generate optimal sizes for social media posts (example)

• Native support of from our friends at Wolt for compact representation of a placeholder for an image

• Post-upload video transcoding for delivering HLS & DASH playlists for adaptive streaming

• On-the-fly image resizing via

Demo