| 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 | ||||
|---|---|---|---|---|
| ||||
|
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 | ||
|---|---|---|
|
Verfügbare Endpunkte
Classified Ad
/adverts: Gibt eine paginierte Liste an Kleinanzeigen nach den gesetzten Filtern aus.Status colour Blue title GET
/adverts/{advert_id}: Gibt die durch die ID spezifizierte Kleinanzeige zurück.Status colour Blue title GET
/adverts: Erstellt eine neue Kleinanzeige.Status colour Green title POST
/adverts/{advert_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Kleinanzeige.Status colour Yellow title PUT
/adverts/{advert_id}: Löscht die durch die ID spezifizierte Kleinanzeige unwiderruflich.Status colour Red title DELETE
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
/cad/categories: Gibt eine Liste der im PORTAL hinterlegten Kategorien für Kleinanzeigen zurück.Status colour Blue title GET
/cad/categories/{category_id}: Gibt die durch die ID spezifizierten Kategorie für Kleinanzeigen zurück.Status colour Blue title GET
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
Verwandte Themen
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|