The API functionality allows external applications to connect to Asset Bank and achieve things including performing searches, retrieving assets, adding assets, adding metadata, etc.

REST API

Asset Bank employs a Jersey-based RESTful API. The URL of your REST API will be the URL of your Asset Bank (including the webapp name) plus "/rest", for example: "https://yourassetbank/asset-bank/rest".

For details on the REST API endpoints please see our REST API Documentation.

We also have several Postman collection examples to help your developers get started.

Authentication

API requests should be authenticated using an OAuth 2.0 token, managed from the Admin > System > API settings page. For more information on accessing Asset Bank through OAuth 2.0, see our OAuth 2.0 Workflow article.

Versions prior to 3.1755

The previous authentication technique for older instances of Asset Bank is to restrict access by IP address (to only allow connections from certain clients).

When using IP restriction, we recommend that you only allow access the API from servers, and not as web-browsing clients, to avoid the risk of CSRF attacks.

Direct Link Cache

The 'direct link cache' enables clients (which can be browsers) to call a URL that converts and returns an image based on request parameters. This can be used to display images resized to particular requirements. See Direct Link Cache