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

Inhaltsverzeichnis anzeigen

Detaillierte Beschreibung

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
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

Berechtigte Nutzer

Die Location API ist eine Adminfunktion, welche Nutzer mit der Berechtigung “Zugang zur API-Dokumentation“abrufen dürfen.

Die Interaktive Bedienung - Try it out

Die API 2.0 BETA Dokumentation kann bereits ohne große Programmierkenntnisse oder ein darauf ausgerichtetes Programm bedient werden. Hierfür gibt es die “Try-it-out” - Funktion.

Jeder Lesende (GET) Endpunkt der Dokumentation hat einen “Try it out” Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion ist ein gültiger API key .

^{Der 'Try it out' Button}

Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die Lesenden Endpunkte (GET) beschränkt.

Location API