kanone

Item-Schnittstelle zum Server (API)

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.

GET-Parameter

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.

BefehlBeschreibungDropDocuDropPhotoDropNewsDropSearchDropAddressDropToursDropPin
interfacePfad 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
 
actionDie action sollte immer command heissen.commandcommandgetItemscommandcommandcommand 
command getItemsgetItems, photos, albums, albums_recursive-realm, searchlistgetTours 
limitMaximale Anzahl Items, die zurück geliefert werden sollen.-limitlimitlimitlimitlimit 
offsetStartwert.-offsetoffset-offsetoffset 
category * categorycategory
(z.B. /exhibitions)
categorycategorycategorycategory 
album dir------
languageGewünschte Sprache.-languagelanguage--language 
searchSuchbegriff für Volltextsuche.---searchsearchsearch 
startcharacterAnfangsbuchstabe-----startcharacter 
filter filter[meta1]-filter[keyword]----
sortEin String oder Zahl gibt an, wonach sortiert wird.sort-sortsort-- 
typeZ.B. json, xml, debug---typetype- 
downloadDownloadbereich bei DropDocu.download------
linkLink zu einer Seite (URL)--link--- 

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.

Interfaces

Der Interfaceparameter ist einer der wenigen Parameter, die pro App unterschiedlich sind. 

AppInterfacecommand
DropEvent/dropnetapps/event/api.phpgetItems
DropAddress/dropnetapps/address/ 
   

Die XML-Antwort (Items)

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="&lt;p&gt;Splendide arrampicate nell'altrettanto splendida cornice di Finale Ligure.&lt;/p&gt;&#010;">
    <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 der Item-ObjekteBeschreibung
idIst immer eine eindeutige ID.
nameMöglichst kurzer Name oder Titel
descriptionBeschreibung
thumbAbsoluter Pfad zum Thumbnail
webAbsoluter Pfad zur Web-Version
srcAbsoluter Pfad zum Original
linkLink zu den Detail Infos (immer absolut)

Je nach App können noch beliebig viele Parameter hinzugefügt werden. Diese werden dann aber nicht von allen Widgets ausgewertet.