| Info |
|---|
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
| Expand | ||||
|---|---|---|---|---|
| ||||
|
Allgemeine Beschreibung
Die
API
Verfügbare Endpunkte
-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=location erreichbar.
Das swagger-File kann auch hier heruntergeladen werden (Stand: ):
| View file | ||
|---|---|---|
|
Verfügbare Endpunkte
Location
HTTP Status Codes
| language | html |
|---|
Status colour Blue title 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
| Code Block | ||
|---|---|---|
| ||
[
{
"id": "1",
"name": "Augsburg",
"name_norm": "augsburg",
"lat": "41.4123541",
"lng": "10.213123412"
}
] |
/locations:Gibt eine paginierte Liste aller Orte aus, optional kann nach einer ID-Liste gefiltert werden.
/locations/coordinates:Gibt eine paginierte Liste von Orten gefiltert nach Koordinaten aus.Status colour Blue title GET
/locations/name:Gibt eine paginierte Liste von Orten gefiltert nach dem Name des Ortes oder Wortanfang für Suchanfragen (Status colour Blue title GET name_prefix) aus.
/locations/zipcode:Gibt eine paginierte Liste von Orten gefiltert nach PLZ oder PLZ-Präfix für Suchanfragen (Status colour Blue title GET zipcode_prefix) aus.
Location Group
/locationgroups:Gibt eine paginierte Liste aller Regionen aus.Status colour Blue title GET
/locationgroups/{group_id}:Gibt die Region aus, gefiltert nachStatus colour Blue title GET group_idaus.
/locationgroups:Erstellt eine neue Region mit den im Request Body angegebenen Orte.Status colour Green title POST
/locationgroups/{group_id}:Aktualisiert die im Request Body angegebenen Informationen des durch dieStatus colour Yellow title PUT group_idspezifierten Beitrags.
/locationgroups/{group_id}:Löscht den durch dieStatus colour Red title DELETE group_idspezifizierte Region unwiderruflich.
Trouble Shooting bei HTTP Status Codes
Verwandte Seiten
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/5oWzAg