How to set up a Filerobot Security template?

Filerobot Security templates generates Access Keys with limited validity and permissions, adapted to be used on frontend applications or on highly-sensitive backend applications.. Their intended purpose is authenticating Filerobot widgets and plugins.

How to create a Security Template?

Navigate to Developers > Security Templates and click on the Create new template button to create a new Security Template:

List of all API permissions can be found here.

4 categories of limits are available:

Limit	Description
Upload limits	rate-limiting for uploads: uploads per minute uploads per source IP folder scope for uploading
Restrict IP limitation	Source IP-whitelisting: whitelisted IP ranges whitelisted countries
Key validity	Key validity period
Listing limits	Folder scope for listing / search

Once saved, a unique Security Template identifier is generated and available for use.

By default, the identifier cannot be called more than 5 times per minute by IP.

How to request API Access key?

In order to instantiate the Filerobot Uploader widget or Filerobot Image Editor widget, you will for most use cases need to specify the filerobotUploadKey parameter for the widgets to interact with your Filerobot asset storage. When the page embedding the widget is loaded, make an API call in order to request an Access Key based on the Security Template previously created.

API Access Keys are generated by calling:

GET      /key/{security_template_identifer}

{security_template_identifer}: the unique identifier of the previously created Security template.

 

cURL example: 

 

curl --request GET \ --url 'https://api.filerobot.com/fdocs/key/SECU_3268740E1C82464B9BC350D868F966CB?' \ --header 'Content-Type: application/json'

 

Response

{
    "status": "success",
    "key": "SASS__v1.05__QM6AXCCNkN2kjR4YDOEBTNzMkQ5IEN2QjM4MUMFBDN3gjNyMzXVNURTpzYlNXCvlmLlJ3b0NncpFmLpBXYu0GdkFWczVnZboDZJoyLlRXYsBXblR3Lj9GZvshOylGZslAMwITM6U2ZhlwG6M2dJshOwl2dJshOylGZ1lAOyATM5ATOxYTM6Q3c__ca972e3142",
    "hint": "New key created and ready to use",
    "debug": null
}

You can use the returned key as the filerobotUploadKey parameter in the Filerobot widget or plugin configuration.