Eine Übersicht der API-Methoden erhalten Sie unter https://enterprise.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 Konfiguration -> API ein- oder ausschalten.
Die Zugriffsberechtigung auf die API wird über API-Keys geregelt. Diese können Sie im Administrationsbereich von VIMP erstellen.
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. Die POST-Methode ist für alle API-Methoden, die sensible Daten enthalten, verpflichtend.
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.
