Versions Compared

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 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 Kleinanzeigen-Moduls kann zum Erstellen, Editieren und Abrufen von Kleinanzeigen verwendet werden.

Funktionalitäten der Kleinanzeigen API

  • Erstellen von Kleinanzeigen

  • Editieren von Kleinanzeigen

  • Abrufen von Kleinanzeigen

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Allgemeine Beschreibung

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=classifiedad erreichbar.

Das swagger-File kann auch hier heruntergeladen werden (Stand: ):

View file
nameapi_module_classifiedad_swagger.json

 

 

Verfügbare Endpunkte

Classified Ad

  • Status
    colourBlue
    titleGET
    /adverts: Gibt eine paginierte Liste an Kleinanzeigen nach den gesetzten Filtern aus.

  • Status
    colourBlue
    titleGET
    /adverts/{advert_id}: Gibt die durch die ID spezifizierte Kleinanzeige zurück.

  • Status
    colourGreen
    titlePOST
    /adverts: Erstellt eine neue Kleinanzeige.

  • Status
    colourYellow
    titlePUT
    /adverts/{advert_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Kleinanzeige.

  • Status
    colourRed
    titleDELETE
    /adverts/{advert_id}: Löscht die durch die ID spezifizierte Kleinanzeige unwiderruflich.

Ein Kleinanzeigenmarkt kann im Modus mit Print oder “online-only” aufgesetzt werden, daher gibt es zwei descriptions: description_online sowie description_print.

Verfügbare Endpunkte für Classified Ad Categories

  • Status
    colourBlue
    titleGET
    /cad/categories: Gibt eine Liste der im PORTAL hinterlegten Kategorien für Kleinanzeigen zurück.

  • Status
    colourBlue
    titleGET
    /cad/categories/{category_id}: Gibt die durch die ID spezifizierten Kategorie für Kleinanzeigen zurück.

Im Gegensatz zu anderen Modulen im PEIQ PORTAL hat der Kleinanzeigenmarkt keine flach nebeneinander liegenden Kategorien, sondern ein Baummodell. Ob eine Kategorie einer anderen untergeordnet ist, lässt sich über die Markierung “is_leaf” steuern.

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 Themen

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