Informationen: API (BETA)

Einführung in die ladv.de API

API Anfragen

API Anfragen sind ganz normale Aufrufe einer URL (in HTTP ein GET Request) welche keine Webseite zum Ergebnis hat sondern JSON. Ein API Aufruf hat immer folgende Syntax:

https://ladv.de/api/<api-key>/<command>?<parameter>=<value>[&<parameter>=<value>]

API Key

API Keys identifizierend den Abfragenden und erlauben es fehlerhafte Abfragen zuzuordnen.

Funktionen

Jede Funktion liefert die Abfrage Möglichkeit für einen bestimmten Teil der auf ladv.de angebotenen Informationen.

Jede Funktion hat einen oder mehrere Parameter die das Ergebnis beeinflussen.

Beispielsweise bietet die Funktion VED (Veranstaltungs Ergebnis Dienst) die Möglichkeit eine Liste von Veranstaltungen und deren Ergebnisse abzufragen die verschiedenen Kriterien wie Jahr, Kreis in dem sie Ausgetragen wurden, entsprechen.

Im Moment sind folgende Funktionen implementiert:

Mit der Zeit kommen sicher noch mehr Funktionen und Parameter dazu.

Parameter

Das Ergebnis der Funktionen wird durch ein oder mehrere Parameter eingeschränkt. Parameter sind immer ein Name/Wert paar. Eine Liste der für die verschiedenen Funktionen unterstützten Parameter ist der Dokumentation der Funktionen zu entnehmen.

Bei der Angebe von Parametern ist unbedingt darauf zu achten, dass Leerzeichen und Umlaute korrekt encodiert werden -> URL Encoding.

Woher bekomme ich einen API Key?

Für die Benutzung der API ist ein Key erforderlich. Dieser wird auf Anfrage zur Verfügung gestellt.

Ergebnis einer API Abfrage

Das Ergebnis des API Aufrufs wird in JSON ausgeliefert. JSON macht den Start, weil es in JavaScript sehr einfach verwendet werden kann und ein sehr kompaktes Datenaustauschformat ist. Andere Formate/Schnittstellen wie XML/Webservice/REST sind noch nicht implementiert. Sollte jemand hier konkreten Bedarf haben, darf er sich gerne melden, der Aufwand dafür ist relativ gering.

Der ContentType der JSON Antworten ist "text/json", die Encodierung ist UTF-8.

Folgender API Aufruf liefert nachstehendes Ergebnis: https://ladv.de/api/test/ved?tag=Cross

[
	{
		"name":"LO Crossserie der Region Süd (1. Lauf)",
		"ort":"Unterkirnach",
		"datum":1197068400000,
		"datumText":"08.12.2007",
		"url":"https://ladv.de/veranstaltung/detail/453",
		"ergebnisse":[
			{
				"name":"Ergebnisliste",
				"type":"HTM",
				"url":"https://ladv.de/ergebnis/datei/658"
			}
		]
	},{
		"name":"Oberschwäbische Crosslauf Serie (1. Lauf)",
		"ort":"Bad Waldsee",
			"datum":1197759600000,
		"datumText":"16.12.2007",
		"url":"https://ladv.de/veranstaltung/detail/454",
		"ergebnisse":[
			{
				"name":"Ergebnisliste",
				"type":"PDF",
				"url":"https://ladv.de/ergebnis/datei/659"
			},{
				"name":"Ergebnisliste [korrigiert]",
				"type":"PDF",
				"url":"https://ladv.de/ergebnis/datei/670"
			}
		]
	}
]