PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

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

Allgemeine Beschreibung

Die API-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: ):

 

Verfügbare Endpunkte

Location

  • GET /locations: Gibt eine paginierte Liste aller Orte aus, optional kann nach einer ID-Liste gefiltert werden.

  • GET /locations/coordinates: Gibt eine paginierte Liste von Orten gefiltert nach Koordinaten aus.

  • GET /locations/name: Gibt eine paginierte Liste von Orten gefiltert nach dem Name des Ortes oder Wortanfang für Suchanfragen (name_prefix) aus.

  • GET /locations/zipcode: Gibt eine paginierte Liste von Orten gefiltert nach PLZ oder PLZ-Präfix für Suchanfragen (zipcode_prefix) aus.

Location Group

  • GET /locationgroups: Gibt eine paginierte Liste aller Regionen aus.

  • GET /locationgroups/{group_id}: Gibt die Region aus, gefiltert nach group_id aus.

  • POST /locationgroups: Erstellt eine neue Region mit den im Request Body angegebenen Orte.

  • PUT /locationgroups/{group_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die group_id spezifierten Beitrags.

  • DELETE /locationgroups/{group_id}: Löscht den durch die group_id spezifizierte Region unwiderruflich.

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

Der Request war nicht akzeptabel.

Das liegt oft an einem fehlenden Parameter. Hier ist der gesendete Request Body zu prüfen.

Eine weitere Ursache bei GET -Requests ist das harte Limit von maximal 10.000 Results. Wir empfehlen daher, die Abfragen noch weiter einzugrenzen, z. B. monats- oder ortsweise, um so die Grenze zu umgehen.

404 - Not Found

Der gesuchte Inhalt konnte nicht gefunden werden bzw. die gesetzten Filter finden keine Ergebnisse.

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.

  • No labels

Impressum