Versions Compared

Old Version 5

changes.mady.by.user Boris Braun

Saved on

compared with

New Version Current

changes.mady.by.user Ilker Oygün

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 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
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4
Detaillierte

Allgemeine 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

-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
nameapi_module_location_swagger.json

 

Image Added

Verfügbare Endpunkte

Location

HTTP Status Codes

Code Block
languagehtml
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 .

Image Removed

 Der 'Try it out' Button

Note

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

 

Verwandte Seiten

Filter by label (Content by label)showLabelsfalseshowSpacefalsecqllabel in ( "api" , "api-dokumentation" ) and space = "PPSD"

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

  • Status
    colourBlue
    titleGET

  • 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

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

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

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

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

Location Group

  • Status
    colourBlue
    titleGET
    /locationgroups:Gibt eine paginierte Liste aller Regionen aus.

  • Status
    colourBlue
    titleGET
    /locationgroups/{group_id}:Gibt die Region aus, gefiltert nach group_id aus.

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

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

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

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

Insert excerpt
API 2.0 Dokumentation PORTAL
API 2.0 Dokumentation PORTAL
name400
nopaneltrue

404 - Not Found

Insert excerpt
API 2.0 Dokumentation PORTAL
API 2.0 Dokumentation PORTAL
name404
nopaneltrue

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel = "api" and space = "PUPKB"

Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation

Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/5oWzAg