Die API des Location-Moduls wird zum Ermitteln von Orts-Objekten (“Locations”) verwendet. Locations können anhand verschiedener Merkmale abgefragt werden, beispielsweise Koordinaten, Namen und PLZ. Es handelt sich bei der Location-API um eine Public API, ein Access Token ist für die Verwendung nicht notwendig.

Funktionalitäten des/der [Moduls/Features/Funktion/Schnittstelle]

Die Location API ist der API-Endpunkt zum Auslesen der Ortsstruktur
Es handelt sich bei der Location-API um eine Public API
Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.

Inhaltsverzeichnis

Inhaltsverzeichnis anzeigen

Detaillierte Beschreibung

Basis URL

https://yourdomain.com/api/v2/locations

Die Location API ist der API-Endpunkt zum Auslesen der Ortsstruktur. Über die unten genannten Endpunkte können die im Portal vorliegenden Orte nach verschiedenen Filtern abgerufen werden.

Verfügbare Endpunkte

GET

All Locations
All Locations by Coordinate Filter
- lat (Latitude)
- lng (Longitude)
All Locations by Name Filter
- name_norm
- name
- name_prefix
All Locations by Zipcode Filter
- zipcode
- zipcode_prefix

Für die Anzahl der Ergebnisse kann ein Limit gesetzt werden.

Response

[
  {
    "id": "1",
    "name": "Augsburg",
    "name_norm": "augsburg",
    "lat": "41.4123541",
    "lng": "10.213123412"
  }
]

HTTP Status Codes

200 - Success       Alles hat wie erwartet funktioniert
400 - Bad Request   Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Location Not Found

Setup & Konfiguration

Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Location-API