Zum Hauptinhalt springen

API (Nicht verfügbar in VIMP Light)

Über die VIMP-API können Sie von anderen Anwendungen aus auf VIMP-Inhalte zugreifen. Die API lässt sich unter Konfiguration -> API aktivieren.

Über die URL www.IhreDomain.de/api (ersetzen Sie IhreDomain.de mit der Domain, unter der VIMP erreichbar ist) erhalten Sie eine ausführliche Beschreibung der verfügbaren API-Methoden.

Über dieselbe URL wird auch auf die API zugegriffen, z.B. www.IhreDomain.de/api/getMedia?apikey=<apikey>

API-Keys​

Über das Backend können Sie beliebig viele API-Keys für unterschiedliche Anwendungen erstellen.

Klicken Sie auf den Link "API-Keys" im oberen Linkbereich, um die API-Key-Verwaltung zu öffnen.

VIMP API-Key-Übersicht

Sobald der Mauszeiger über einen Eintrag bewegt wird, blendet sich das Kontext-Menü ein:

  • Bearbeiten: Öffnet die API-Key-Bearbeitung.
  • Löschen: Löscht den entsprechenden API-Key.

API-Key hinzufügen/bearbeiten​

Zum Hinzufügen neuer API-Keys klicken Sie einfach auf den „Hinzufügen“ Button auf der Übersichtsseite.

Geben Sie dem API-Key einen eindeutigen Namen, über den Sie Ihn in der API-Key-Verwaltung identifizieren können.

Geben Sie anschließend Ihren Wunsch-API-Key ein oder lassen Sie einen zufälligen über den „Generator“-Link erstellen. Die Zeichenlänge können Sie über Konfiguration -> API festlegen.

Die Laufzeit des Tokens können Sie individuell festlegen.

Setzen Sie abschließend den gewünschten Status des API-Keys.

Die erscheinende Maske ist identisch zur Bearbeiten-Maske:

VIMP API-Key-Bearbeitung

pdf-download-icon PDF herunterladen