Skip to main content

API (Not available in VIMP Light)

The API allows you to read and write VIMP data through another application. It can be enabled at Configuration -> API within the backend.

Go to www.yourDomain.com/api (replace yourDomain.com with your VIMP domain) to see a detailed description of all available API methods.

Use the same URL to access the API methods, e.g. www.yourdomain.com/api/getMedia?apikey=<apikey>

API-Keys​

You can create an unlimited number of API keys for different applications in the backend.

Enter the API key management by clicking the "API-Keys" link in the top link list.

VIMP api keys overview

By moving the mouse over a menu item in the list a context menu appears:

  • Edit: Edit the according API Key.
  • Delete: Delete the according API Key.

Adding/editing an API key​

In order to add new API keys just click the „Add“ button on the overview page.

The opening form is identical to the edit form:

VIMP edit api key

Enter a unique name for the API key to help you to identify the key within the API key management.

Next, enter your desired API key or use the generator to create a random one. The character length is defined at Configuration -> API.

The token lifetime defines the timeframe in seconds the token shall be valid whereas value “-1” uses the default value defined at Configuration -> API and value “0” sets the lifetime to infinite.

Finally, set the status of the API key.

pdf-download-icon Download PDF