API
Mit der mediaDESK API kann mediaDESK in andere Programme und Websites integriert werden. Sie können damit z.b. aus Ihrem Produktdatenbank-Programm (ERP-System) automatisiert eine neue Kategorie in mediaDESK anlegen, sobald im ERP-System ein neues Produkt angelegt wird. Mit der Upload-API können Sie dann auch Produktbilder und Dateien in diese Kategorie hochladen. mediaDESK ist somit ein zentraler Datenspeicher (z.b. Bilddatenbank) auf dem sie über Schnittstellen von ihren Unternehmensanwendungen zugreifen können.
Aufbau der HTTP-Requests
Grundlegende Funktion
Die API ist derzeit sehr einfach aufgebaut. Im wesentlichen gibt es für die mediaDESK-Funktionen spezielle URL (Internet-Adressen) die zusammen mit einem Benutzer und Passwort aufgerufen werden müssen um diese Funktion auszuführen:
Alle Funktionen sind über die URL erreichbar:
http://demo.mediadesk.net/gateway/api/
Parameter:
- USERNAME= (der username unter dem diese funktion ausgeführt werden soll)
- PASSWORD= (das passwort des angegebenen benutzers)
- method= (die jeweilige Funktion die ausgeführt werden soll)
- param= (wenn nötig ein oder mehrere Parameter die die Funktion benötigt
| Achtung: |
| Bei den Parametern unbedingt die Gross/Kleinschreibung beachten! USERNAME und PASSWORD muss in Großbuchstaben geschrieben werden. |
API Test
Parameter:
- USERNAME
- PASSWORD
- method = echo (Führt die Echo-Funktion aus)
- param = Ein Text der zurückgegeben werden soll (Echo)
categoryExist: Existiert eine Kategorie
Mit der Funktion categoryExist kann geprüft werden ob eine angegebene Kategorie existiert:
Parameter:
- USERNAME
- PASSWORD
- method = categoryExist
- param = Pfadangabe für Kategorie (Name) nach dem Schema #ersteEbene#/#unterkategorie1#/#unterkategorie2#
Pfadangabe:
Nachdem Kategorien auch Unterkategorien haben können, kann mit dieser Funktion der gesamte Pfad geprüft werden. Wenn es eine Hauptkategorie Kontinente gibt und Europe eine Unterkategorie ist kann das mit param=Kontinente/Europe überprüft werden. Es ist dabei nicht der Kategorietitel sondern der Kategoriename zu übergeben.
categoryCreate: Anlegen einer Kategorie
Mit categoryCreate kann eine neue Kategorie angelegt werden:
Parameter:
- USERNAME
- PASSWORD
- method = categoryCreate
- param (1) = Name für die neue/anzulegende Kategorie
- param (2) = Titel für die neu/anzulegende Kategorie
Pfadangabe:
Beim ersten param - Parameter kann statt dem Namen auch der komplette Kategorie-Pfad (z.b. Kontinente/Europe/Austria) angegeben werden, um eine Unterkategorie anzulegen.
categoryDelete: Löschen eine Kategorie
Mit categoryDelete kann eine Kategorie gelöscht werden.
URL: http://demo.mediadesk.net/gateway/api/?USERNAME=admin&PASSWORD=admin&method=categoryDelete¶m=catname
Parameter:
- USERNAME
- PASSWORD
- method = categoryDelete
- param = Name bzw. Pfadangabe der Kategorie die gelöscht werden soll
Pfadangabe:
Beim ersten param - Parameter kann statt dem Namen auch der komplette Kategorie-Pfad (z.b. Kontinente/Europe/Austria) angegeben werden, um eine Unterkategorie anzulegen.
categoryChangeDate: Datum der letzten Änderung ermitteln
Content noch nicht befüllt
removeObjectsFromCategory: Entfernen alle Dateien aus einer Kategorie
Mit der Funktion removeObjectsFromCategory können alle Dateien aus einer Kategorie entfernt werden:
Parameter:
- USERNAME
- PASSWORD
- method = removeObjectsFromCategory
- param = Id der Kategorie von der die Dateien gelöscht werden sollen
Rückgabe:
OK wenn alle Dateien erfolgreich gelöscht wurden.
FAILED;ObjectNotFoundException; wenn die Kategorie nicht existiert
FAILED;IOServiceException; wenn ein anderer Fehler aufgetreten ist.
addObjectsToCategory: Hinzufügen von Dateien zu einer Kategorie
Content noch nicht befüllt
getObjectsFromCategory: Auflisten von Dateien in einer Kategorie
Mit getObjectsFromCategory können die Dateien einer Kategorie aufgelistet werden.
Parameter:
- USERNAME
- PASSWORD
- method = getObjectsFromCategory
- param = ID der Kategorie, von der die Dateien aufgelistet werden sollen
Rückgabewert:
Eine Liste von Objekt-IDs der Dateiobjekte mit Semikolon getrennt, z.b.:
233;234;236;
Die Objekte können mit dieser URL angezeigt werden: http://demo.mediadesk.net/imageservlet/#id#/1/
Beispiel:
http://demo.mediadesk.net/imageservlet/27/1/
Implementierungen
Es sind einige fertig verwendbare Libaries geplant um Dritt-Programme und Webseiten an mediaDESK über diese API anzubinden. Darunter Java, PHP,...
Java Libary
Nachdem Java eine sehr verbreitete Sprache ist wird derzeit nur eine Java-Libary für den Zugriff auf mediaDESK - Funktionen angeboten. Der Download wird hier noch nicht angeboten. Auf Anfrage stellen wir die Java-Libary aber gerne zur Verfügung.