Zusammenfassung
Webservice | REST |
---|---|
Objekt | JSON |
Trigger | GET, POST, PUT, DELETE |
Anbieter | PEIQ |
Syntax | Kleinanzeigenmarkt-API |
Die API des Kleinanzeigen-Moduls kann zum Erstellen, Editieren und Abrufen von Kleinanzeigen verwendet werden.
Produkt (Label) | Portal |
Übergeordnetes Modul (Label) | API, Kleinanzeigen |
Inhaltsverzeichnis
Interne Beschreibung
Basis URL
https://yourdomain.com/api/v2/cad/adverts
Die Kleinanzeigenmarkt API ist die API zum Erstellen, Editieren und Abrufen von Kleinanzeigen. Ein Kleinanzeigenmarkt kann im Modus mit Print oder “online-only” aufgesetzt werden, daher gibt es zwei descriptions getrennt für print und online. Zudem hat der Markt ein integriertes Modul zur Abbildung verschiedener Preismodelle (PaidServicesBundle) im Kleinanzeigenmarkt die über den API Endpunkt definiert werden können bzw beim Anlegen von Kleinanzeigen auch definiert werden müssen.
Former user (Deleted) was sind denn hier die meta values und die cs_print_ parameter? Product IDs beziehen sich auf die Printprodukte oder!?
Verfügbare Endpunkte für Classified Ads
GET
Get All Classified Ad by Filters
approval_status (Available values : none, verified, pending, approved, resubmitted)
payment_status (Available values : free, notpaid, paid)
date_filter_type (Available values : created, updated ; Default value : created)
date_start
date_end
Get Classified Ad by advert_id
advert_id
Response
{ "total_results": 234, "total_pages": 12, "page": 1, "page_size": 20, "data": [ { "id": 1, "title": "Advert1", "approval_status": "pending", "payment_status": "free", "service_fee": 12.99, "description_online": "Lorem ipsum dolor sit amet, consectetur adipisicing elit. In, consectetur, animi, culpa beatae optio quod ea rerum impedit magni modi vel totam consequuntur porro voluptate unde.", "description_print": "coming soon...", "pricemode": "pm_free", "price": 85.99, "contact": { "phone": "+49 821 312312", "email": "max@mustermann.de" }, "hide_phone": true, "url": "https://www.example.com/cad/augsburg/c-sachbuch/advert1_c4", "billing_information": { "firstname": "Max", "lastname": "Mustermann", "street": "Example Street", "street_number": "32", "city": "Augsburg", "zipcode": "86159", "phone": "+49 821 3125123", "email": "max@mustermann.de" }, "created": "2019-03-07T00:00:00+00:00", "updated": "2019-03-09T02:00:00+00:00", "expires": "2019-03-27T00:00:00+00:00", "category_id": 8, "zipcode": "86150", "city": "Augsburg", "street": "Maximilianstraße", "street_number": "23", "cs_print_consecutive": 1, "cs_print_disabled": false, "meta": [ { "k": "test-key", "v": "test-value" } ], "location_id": 1, "product_ids": [ 1, 2, 3 ], "images": [ { "url": "www.example.com/path/to/image/1" } ], "print_options": [ "option1", "option2" ] } ] }
POST
Create Classified Ad
PUT
Update Classified Ad by advert_id
advert_id
DELETE
Delete Classified Ad by advert_id
advert_id
Request Body
{ "title": "Advert1", "approval_status": "pending", "description_online": "Lorem ipsum dolor sit amet, consectetur adipisicing elit. In, consectetur, animi, culpa beatae optio quod ea rerum impedit magni modi vel totam consequuntur porro voluptate unde.", "description_print": "coming soon...", "pricemode": "pm_free", "price": 85.99, "contact": { "phone": "+49 821 312312", "email": "max@mustermann.de" }, "hide_phone": true, "billing_information": { "firstname": "Max", "lastname": "Mustermann", "street": "Example Street", "street_number": "32", "city": "Augsburg", "zipcode": "86159", "phone": "+49 821 3125123", "email": "max@mustermann.de" }, "category_id": 8, "zipcode": "86150", "city": "Augsburg", "street": "Maximilianstraße", "street_number": "23", "meta_form_data": [ { "k": "test-key", "v": "test-value" } ], "location_id": 1, "product_ids": [ 1, 2, 3 ], "images": [ { "url": "www.example.com/path/to/image/1" } ], "print_options": [ "option1", "option2" ] }
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 201 - Classified Ad Successfully created / deleted 204 - Classified Ad Successfully updated 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - Classified Ad Not Found Die Anzeige mit der angegebenen ID scheint nicht zu existieren
Verfügbare Endpunkte für Classified Ad Categories
Im Gegensatz zu anderen Modulen aus der PEIQ Portalreihe 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.
GET
Get All Classified Ad Categories
Get Classified Ad Category by category_id
category_id
Response
{ "id": "1", "name": "Leaf-Category-Test", "name_norm": "leaf-category-test", "form_fields": [ { "name": "root-testfield", "type": "Symfony\\Component\\Form\\Extension\\Core\\Type\\TextType", "options": { "required": true, "choices": "{}" } } ], "is_leaf": true }
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - Category Not Found Die Kategorie mit der angegebenen ID scheint nicht zu existieren
Setup & Konfiguration
Aktivierung Feature | Aufwand Technik |
---|---|
Als Change Request (Releaseunabhängig) | 0,25PH |
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation” Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup. |
|
Konfigurationsparameter
Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.
Bekannte Einschränkungen
s. allgemeine Bekannte Einschränkungen der PEIQ API Anbindung
Entwicklungsverlauf
Links zu Issues, Tickets, etc. Neueste zuerst:
Modul im Einsatz bei
[SGU] (stadtanzeiger-ortenau.de) ONLINE (V2)
Verwandte Themen
Verwandte Seiten
Filter by label
There are no items with the selected labels at this time.
Verwandte Labels
Ansprechpartner
Teil 2 - EXTERN für Kunden & Interessenten EXTERN
In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert.
Neue Auszüge können über /auszug
erstellt werden.
Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087.
Allgemeine Beschreibung EXTERN
Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?
Details EXTERN
Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).
Vorläufig übertragen aus Extern (Externe Seite gelöscht)
Die API des Kleinanzeigen-Moduls kann zum Erstellen, Editieren und Abrufen von Kleinanzeigen verwendet werden.
Bei der Kleinanzeigenmarkt-API handelt es sich um ein Feature, welches releaseunabhängig im Rahmen einer Änderungsanfrage aktiviert werden kann.
Die API 2.0 Dokumentation dagegen ist auch ohne Aktivierung vorhanden.
Funktionalitäten der Kleinanzeigenmarkt-API
Diverse Endpunkte
Trigger: GET, POST, PUT, DELETE
Die Basis URL
https://yourdomain.com/api/v2/cad/adverts
Die Kleinanzeigenmarkt-API ist die API zum Erstellen, Editieren und Abrufen von Kleinanzeigen. Ein Kleinanzeigenmarkt kann im Modus mit Print oder “online-only” aufgesetzt werden, daher gibt es zwei ‘descriptions’, getrennt für print und online. Zudem hat der Kleinanzeigenmarkt ein integriertes Modul zur Abbildung verschiedener Preismodelle (PaidServicesBundle) im Kleinanzeigenmarkt die über den API Endpunkt definiert werden können bzw beim Anlegen von Kleinanzeigen auch definiert werden müssen.
Verfügbare Endpunkte für Classified Ads
GET
Get All Classified Ad by Filters
approval_status (Available values : none, verified, pending, approved, resubmitted)
payment_status (Available values : free, notpaid, paid)
date_filter_type (Available values : created, updated ; Default value : created)
date_start
date_end
Get Classified Ad by advert_id
advert_id
POST
Create Classified Ad
PUT
Update Classified Ad by advert_id
advert_id
DELETE
Delete Classified Ad by advert_id
advert_id
Response Body
{ "total_results": 234, "total_pages": 12, "page": 1, "page_size": 20, "data": [ { "id": 1, "title": "Advert1", "approval_status": "pending", "payment_status": "free", "service_fee": 12.99, "description_online": "Lorem ipsum dolor sit amet, consectetur adipisicing elit. In, consectetur, animi, culpa beatae optio quod ea rerum impedit magni modi vel totam consequuntur porro voluptate unde.", "description_print": "coming soon...", "pricemode": "pm_free", "price": 85.99, "contact": { "phone": "+49 821 312312", "email": "max@mustermann.de" }, "hide_phone": true, "url": "https://www.example.com/cad/augsburg/c-sachbuch/advert1_c4", "billing_information": { "firstname": "Max", "lastname": "Mustermann", "street": "Example Street", "street_number": "32", "city": "Augsburg", "zipcode": "86159", "phone": "+49 821 3125123", "email": "max@mustermann.de" }, "created": "2019-03-07T00:00:00+00:00", "updated": "2019-03-09T02:00:00+00:00", "expires": "2019-03-27T00:00:00+00:00", "category_id": 8, "zipcode": "86150", "city": "Augsburg", "street": "Maximilianstraße", "street_number": "23", "cs_print_consecutive": 1, "cs_print_disabled": false, "meta": [ { "k": "test-key", "v": "test-value" } ], "location_id": 1, "product_ids": [ 1, 2, 3 ], "images": [ { "url": "www.example.com/path/to/image/1" } ], "print_options": [ "option1", "option2" ] } ] }
Der Response Body - Struktur einer Kleinanzeige
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 201 - Classified Ad Successfully created / deleted 204 - Classified Ad Successfully updated 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - Classified Ad Not Found Die Anzeige mit der angegebenen ID scheint nicht zu existieren
HTTP Status Codes
Verfügbare Endpunkte für Classified Ad Categories
Im Gegensatz zu anderen Modulen aus der PEIQ Portalreihe 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.
GET
Get All Classified Ad Categories
Get Classified Ad Category by category_id
category_id
Release-Notes EXTERN
Monat 202X - Zusammenfassung
Text
Monat 202X - Zusammenfassung
Text
Anleitung zum Setup EXTERN
Historie
Version | Date | Comment |
---|---|---|
Current Version (v. 1) | 2020-09-27 08:30 | Boris Braun |
v. 16 | 2024-02-09 14:47 | Kathrin Janka |
v. 15 | 2024-02-08 14:32 | Kathrin Janka |
v. 14 | 2022-08-18 10:09 | Former user |
v. 13 | 2022-08-18 08:54 | Former user |
v. 12 | 2022-08-18 08:37 | Former user |
v. 11 | 2022-03-15 15:21 | Former user |
v. 10 | 2020-10-27 15:16 | Former user |
v. 9 | 2020-10-22 05:04 | Franziska Franz |
v. 8 | 2020-10-22 05:03 | Franziska Franz |
v. 7 | 2020-10-19 08:40 | Franziska Franz |
v. 6 | 2020-10-06 08:12 | Boris Braun |
v. 5 | 2020-10-06 07:51 | Boris Braun |
v. 4 | 2020-10-06 07:42 | Boris Braun |
v. 3 | 2020-10-06 07:38 | Boris Braun |
v. 2 | 2020-09-27 12:12 | Boris Braun |
v. 1 | 2020-09-27 08:30 | Boris Braun |