Grundlagen

URL

Die Basis-URL und das Parameter-Schema für alle API-Aufrufe lautet: http://www.bootsmarkt.de/index.php/Api/function/apikey/format/parameter1/.../parameterx.html

Je nach aufgerufener Funktion werden unterschiedliche GET-Parameter erwartet. In jedem Fall muss nach dem Funktionsnamen jedoch zunächst der Apikey und das gewünschte Ausgabeformat angegeben werden.

Die Auflistung aller verfügbaren Methoden erläutert Ihnen die jeweils möglichen Parameter und Rüchgabedaten.

Authentifizierung mit dem API-Key

Der API-Key ist eine 32stellige Zeichenfolge, die Ihnen von der Bootsmarkt-Redaktion bei Ihrer Registrierung als
API-User mitgeteilt wird. Wenn Sie die Bootsmarkt-API einsetzen wollen, dann wenden Sie sich bitte an dieck@bootsmarkt.de.

Antwortformat

Über den GET-Parameter "format" können Sie selbst wählen, ob Sie die Ergebnisdaten im Format XML oder JSON erhalten möchten.

Mögliche Werte der GET-Parameter:

  • "xml" oder "json"

Ergebnis

Jede Ausgabe der API beginnt zunächst mit einem Zeitstempel und der Angabe der API-Version
(hier abgebildet die XML-Variante):


	<bootsmarkt>
	    <query>
	        <timestamp>1343660804</timestamp>
	        <api-version>1.10</api-version>
	    </query>
	    ...
	</bootsmarkt>
	

Fehlermeldungen

Falls ein Fehler aufgetreten ist, wird ein Fehler-Code ausgegeben:

Fehlercodes
CodeErklärung
no valid formataußer XML und JSON sind derzeit keinen anderen Ausgabeformate vorgesehen
no valid numbereine Zahlenangabe wurde entweder nicht korrekt gesetzt oder liegt außerhalb des erlaubten Bereichs
no valid function calldie aufgerufene Funktion existiert nicht
no such idein Boot, Motor oder eine Adresse mit dieser ID existiert nicht
bad requestdie Abfrage ist fehlerhaft
no valid typebei den Booten gibt es nur die Typen MY (=Motoryachten), SY (=Segelyachten) und
SB (=Schlauchboote)