Einleitung

Willkommen auf der offiziellen Website der LAND-DATA API Dokumentation. Die Dokumentationen, die wir Ihnen auf dieser Plattform zur Verfügung stellen, sollen als Wissensgrundlagen für die Schnittstellen unserer Systemen dienen. Sie enthalten Informationen zu den verfügbaren Endpunkten, Abfrageparametern, Anforderungs- und Antwortformaten.

Unsere API-Dokumentation ist wie folgt strukturiert, um Ihnen eine möglichst einfache und verständliche Navigation zu ermöglichen. Der oberste Menüpunkt in unserer Dokumentation bezieht sich auf die entsprechende Domäne. Unter jeder Domäne sind die verfügbaren Services aufgelistet. Für jede Domäne gibt es kurze Einleitung, um die Schnittstellen in einen fachlichen Kontext einzuordnen. Die Schnittstellen werden dann durch die API Dokumentation erklärt. Sie finden hier genauere Informationen über die Funktionsweise der Schnittstellen und wie sie eingesetzt werden können. Unsere API-Dokumentationen können in verschiedenen Versionen verfügbar sein, je nach Aktualisierungen oder Verbesserungen, die wir an unseren Diensten vornehmen.

Unsere Teams arbeiten kontinuierlich an der Verbesserung und Aktualisierung unserer APIs, damit wir Ihnen die besten und nutzerfreundlichsten Lösungen anbieten können. Ihre Rückmeldungen und Vorschläge sind uns deshalb wichtig, um unsere Produkte zu optimieren. Wir hoffen, dass Sie durch die Nutzung unserer APIs die Leistungsfähigkeit und Vielseitigkeit Ihrer eigenen Software maximieren können.

OpenAPI Spezifikation

Zur Beschreibung der Schnittstellen wird die OpenAPI Spezifikation genutzt. Sie hat den Vorteil, dass die API-Definition einerseits in einem einheitlichen maschinenlesbaren Format vorliegt, andererseits aber auch für den Menschen einfach zu verstehen und zu verwenden ist. Aus dieser Definition wird automatisch eine programmiersprachenunabhängige, HTML-basierte Dokumentation erstellt (SwaggerUI). Die SwaggerUI listet alle möglichen Anfragen auf, ordnet diese in zusammengehörige Gruppen und setzt HTTP-Methoden farblich ab. Jede Anfrage enthält eine Beschreibung mit nötigen Parametern, HTTP-Antworten, HTTP-Statuscodes und Beispielen.