Auf die API zugreifen

Editionen: Enterprise, Ultimate, Corporate
Versionen: 2.2.0+

Eine Übersicht der API-Methoden erhalten Sie unter https://corporate.demo.vimp.com/api. In Ihrem eigenen Portal rufen Sie die API-Beschreibung über https://www.meinedomain.tld/api auf.

Die ViMP API lässt sich über das Backend (Konfiguration -> API) ein- oder ausschalten.

Die Zugrifssberechtigung auf die API wird über API-Keys geregelt (siehe hier).

Auf die API-Methoden kann auf unterschiedliche Art und Weise zugegriffen werden.

GET-Zugriff:
Beim Zugriff mittels der GET-Methode werden alle erforderlichen Parameter über die URL übergeben.

Beispiel:
http://www.meinedomain.tld/api/getCategories/apikey/meinapikey

POST-Zugriff:
Beim Zugriff mittels der POST-Methode werden die Parameter URL-codiert an den Server gesendet.

Beide Zugriffsarten lassen sich z.B. leicht per cURL in andere Applikationen implementieren.

Als Antwort sendet der Server die angeforderten Daten entweder als XML- oder JSON-String zurück. Das jeweilige Ausgabeformat kann über das ViMP-Backend eingestellt werden.

Zuletzt aktualisiert am 07.07.2021 von Admin.

Zurück