Kleinanzeigen API

Funktionalitäten der Kleinanzeigen API

• Erstellen von Kleinanzeigen

• Editieren von Kleinanzeigen

• Abrufen von Kleinanzeigen

Inhaltsverzeichnis

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: Aug 10, 2022):

Open

Open

^{Interaktive Dokumentation im Admin-Bereich des PORTALs}

 

 

Verfügbare Endpunkte

Classified Ad

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

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

• POST /adverts: Erstellt eine neue Kleinanzeige.

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

• DELETE /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

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

• GET /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

Verwandte Themen

^{Nur für PEIQ-Mitarbeiter:innen}
https://peiq.atlassian.net/wiki/x/pALQAg