Mithilfe der PEIQ Cloud-Connect APIs (engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff wird dabei über die Standard HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.
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 der Location API
Ermittlung von Orts-Objekten (“Locations”)
Abfragen von Merkmalen wie Koordinaten, Namen und PLZ
Inhaltsverzeichnis
Grundlegendes zur Location API
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
location_ids
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"
}
]
Trouble Shooting bei HTTP Status Codes
Verwandte Seiten
Disclaimer
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.