Die DropNet Web Apps bieten alle dieses API. Die Parameter sind sehr einfach und einheitlich, so dass man schnell damit arbeiten kann. So hat man direkten Zugriff auf die Apps, um zum Beispiel Bilder aus einem Album inkl. Text auszulesen. Die kompatible Schnittstelle ermöglicht so die unterschiedlichsten Darstellungen der Daten mit sehr wenig Aufwand. Das spart Entwicklungskosten und bietet fast grenzenlose Möglichkeiten.
Per GET können über das API die XML-Antworten angefordert werden. Die Anfragen müssen so kompatibel, wie nur möglich sein, damit die unterschiedlichen Widgets an die verschiedenen APIs angehängt werden können.
| Befehl | Beschreibung | DropDocu | DropPhoto | DropNews | DropSearch | DropAddress | DropTours | DropEvent | DropShop | DropPin |
|---|---|---|---|---|---|---|---|---|---|---|
| interface | Pfad zum Programm, welches das XML erstellt. Ohne diesen Parameter wird das Standardprogramm gewählt. | /dropnetapps /account/ | /dropnetapps /photo/api.php | /dropnetapps /news/api.php | /cgi-bin/swisscanto-stiftungen/search/search.cgi | /dropnetapps /address/ | /dropnetapps /tours/api.php | /dropnetapps /event/api.php | /cgi-bin/kunde /shop/shop.pl | |
| action | Die action sollte immer command heissen. | command | command | command | command | command | command | command | command | |
| command | getItems | getItems, photos, albums, albums_recursive | getItems | realm, search | getItems | getItems, getAddresses | getItems | getItems | ||
| limit | Maximale Anzahl Items, die zurück geliefert werden sollen. | - | limit | limit | limit | limit | limit | limit | limit | |
| offset | Startwert. | - | offset | offset | - | offset | offset | - | offset | |
| category * | category | category (z.B. /exhibitions) | category | category | category | category | category | category | ||
| album | dir | - | - | - | - | - | calendar | - | - | |
| language | Gewünschte Sprache. | - | language | de, en ... | - | - | language | language | language | |
| search | Suchbegriff für Volltextsuche. | - | - | search | search | search | search | search | search | |
| searchmode | AND, OR | - | - | - | - | - | - | - | searchmode | - |
| startcharacter | Anfangsbuchstabe | - | - | - | - | - | startcharacter | - | - | |
| filter | filter[meta1] | - | filter[keyword] | - | - | - | - | meta ... | - | |
| sort | Ein String oder Zahl gibt an, wonach sortiert wird. | sort | - | sort | sort | - | - | - | - | |
| sort_direction | asc, desc | - | - | asc, desc | - | - | - | - | - | - |
| type | Z.B. json, xml, debug | - | - | assistant | type | type | - | - | - | |
| download | Downloadbereich bei DropDocu. | download | - | - | - | - | - | - | - | - |
| link | Link zu einer Seite (URL) | - | - | link | - | - | - | - | - | |
| date_start | Startdatum | - | date_start | - | ||||||
| date_end | Enddatum | - | date_end | - | ||||||
| random | 0 oder 1 | - | - | - | - | - | - | - | random | - |
Pflichtfelder: Diese Parameter muss jede App mit Item-Schnittstelle zuverlässig auswerten.
* Es sind auch mehrere Kategorien möglich (Wie trennen?). Bei DropPhoto sind mit der Category Alben gemeint.
Der Interfaceparameter ist einer der wenigen Parameter, die pro App unterschiedlich sind.
| App | Interface | command |
|---|---|---|
| DropEvent | /dropnetapps/event/api.php | getItems |
| DropAddress | /dropnetapps/address/ | |
Die Antworten werden immer mit dem identischen Aufbau als XML zurück gegeben. Die Widgets nutzen diese Schnittstelle. Weil die Schnittstelle für alle Apps identisch ist, können die Widgets für die Darstellung jeglicher Daten eingesetzt werden. Alle Pfade und URLs müssen vollständig absolut zurück gegeben werden, damit die Item-Schnittstelle auch domainübergreifend funktioniert.
<?xml version="1.0" encoding="UTF-8"?>
<menu type="photos" name="Arrampicata a Finale Ligure" description="<p>Splendide arrampicate nell'altrettanto splendida cornice di Finale Ligure.</p>
">
<item id="2017-05-27-17-35-39-img_9227-1923.jpg" panorama="0" name="Foto di Thomas Arn" description="" thumb="https://ssl.dropnet.ch/casticino/dropbox/photo/gite/2017/2017-05-25-arrampicata-a-finale-ligure/thumbnails/2017-05-27-17-35-39-img_9227-1923.jpg" web="https://ssl.dropnet.ch/casticino/dropbox/photo/gite/2017/2017-05-25-arrampicata-a-finale-ligure/mysize/2017-05-27-17-35-39-img_9227-1923.jpg" src="https://ssl.dropnet.ch/casticino/photo/gite/2017/2017-05-25-arrampicata-a-finale-ligure/2017-05-27-17-35-39-img_9227-1923.jpg" />
</menu>
| Rückgabe-Parameter des Menu-Objektes | Beschreibung |
|---|---|
| name | DropEvent - insertEvent |
| count | Anzahl zurückgegebener Items |
| count-all | Total Anzahl Items |
| count-selection | Anzahl Items dieser Selektion |
| language | de, fr ... |
| time | Ausführungszeit in Sekunden |
| type | xml |
| error | Fehler als Zahl [1], ohne Fehler = 0 |
| error-string | Beschreibung des Fehlers (in der richtigen Sprache) |
| version | API-Version |
| version-string | Beschreibung der Version |
| Rückgabe-Parameter der Item-Objekte | Beschreibung |
|---|---|
| id | Ist immer eine eindeutige ID. |
| name | Möglichst kurzer Name oder Titel (Immer nur Text) |
| intro | Kurzform des Textes, Lead oder Intro (darf auch HTML beinhalten) |
| description | Längere Beschreibung (darf auch HTML beinhalten) |
| detail | Umfangreiche Beschreibung (darf auch HTML beinhalten) |
| thumb | Absoluter Pfad zum Thumbnail |
| web | Absoluter Pfad zur Web-Version |
| src | Absoluter Pfad zum Original |
| link | Link zu den Detail Infos (immer absolut) |
| class | Hier können Klassen zurückgegeben werden, die für die spätere Filterung verwendet werden. |
| date | Dieses einfache Datum kommt je nach Sprache bereits formatiert (12. Jan 2019). |
Je nach App können noch beliebig viele Parameter hinzugefügt werden. Diese werden dann aber nicht von allen Widgets ausgewertet.
Die Werte in Arrays werden mit :: (zwei Doppelpunkte) getrennt. Beispiel:
wert1::wert2
