AssetFeed: Deliver Images Straight into External Systems

With the AssetFeed add-on you make selected images from VAULO available to other systems – your website, a shop, a CMS or a partner app, for example. The feed is a public URL without login that returns a JSON list of your published assets. The images themselves are fetched through a URL scheme you define yourself. What the JSON looks like is up to your template.

How AssetFeed works (overview)

1. Create an AssetFeed (title and path of the feed URL)
2. Configure endpoints, URL scheme and JSON template
3. Publish files in the feed
4. The external system fetches the feed URL and loads the images through the asset URLs

Activate and open the add-on

Creating an AssetFeed requires admin rights in your organization. You find the add-on under Settings → Add-Ons → AssetFeed. Click Manage to open the overview of your feeds. On first use you are asked to activate the add-on.

Create an AssetFeed

In the overview, click Create AssetFeed and fill in the two fields:

• Title – the name of the feed as it appears in VAULO and in the JSON (feed.title), for example Press images.
• Feed URL – the path after your organization name, for example press. The path has to be unique within your organization.

If your organization is called mustermann in VAULO, the feed is reachable at https://share.vaulo.com/mustermann/press. If you have connected a custom domain such as media.mustermann.ag to VAULO, the address is https://media.mustermann.ag/press.

Right after creation the Customize AssetFeed dialog opens. A new feed already comes with a working default configuration: one API with a list endpoint on the feed URL and a single asset endpoint with the URL scheme assets/{filename}. So you can publish files and test the feed straight away. Copy next to the Feed URL puts the address on your clipboard.

Publish files

A feed only delivers files you have published in it. There are two ways to do that:

1. Through the share dialog: Select one or more files, open Share and switch to the AssetFeed tab. Tick the feeds you want and click Publish in AssetFeeds. The tab only appears when the add-on is active and at least one feed exists.
2. In the file details: The AssetFeed section lists all feeds of your organization with a Published toggle. This is also where you remove a file from a feed again.

Unpublished files are not reachable through the feed – and the feed does not reveal whether they exist.

Access and security

• Public, without password. An AssetFeed is meant for machines, which cannot enter a password. Password protection is therefore not available for this share type.
• Validity period. As with other shares you can define a period. Outside of it the feed answers with status code 401.
• Asset URLs are temporary. The url values in the JSON point directly at the image files and expire after the configured validity. An external system should re-fetch the feed URL regularly instead of storing the image URLs permanently. The permanent addresses of the images are given by your URL scheme, for example …/press/assets/summer-party.jpg.
• Views. Every fetch of the feed URL counts as one view of the share – no matter how many images the external system loads afterwards.

Read on