Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

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

, DELETE

Anbieter

PEIQ

Syntax

Kleinanzeigenmarkt-API

Info

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.

Produkt (Label)

Portal

Übergeordnetes Modul (Label)

API,

Funktionalitäten der Kleinanzeigen API

Erstellen von Kleinanzeigen
Editieren von Kleinanzeigen
Abrufen von Kleinanzeigen

Inhaltsverzeichnis

Expand

title	Inhaltsverzeichnis anzeigen

Table of Contents

maxLevel	4

Interne Beschreibung

Basis URL

Code Block

language	text

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

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

View file

name	api_module_classifiedad_swagger.json

Image Added

Verfügbare Endpunkte

Classified Ad

Status
colour Blue
title

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

Code Block

language	json

{ "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" ] } ] }Create Classified Ad

GET
/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 Green
title

postUpdate Classified Ad by

POST
/adverts: Erstellt eine neue Kleinanzeige.
Status
colour Yellow
title

put

PUT
/adverts/{advert_id

advert_id

Delete Classified Ad by

}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Kleinanzeige.
Status
colour Red
title

delete

DELETE
/adverts/{advert_id

advert_id

Request Body

Code Block

language	json

{
  "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

Code Block

language	text

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

}: 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
colour Blue
title GET
/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.

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.

Status

colour	Blue
title	get

Get All Classified Ad Categories
Get Classified Ad Category by category_id
- category_id

Response

Code Block

language	json

{
  "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

Code Block

language	text

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)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

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

Warning
Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.

Bekannte Einschränkungen

Note
s. allgemeine Bekannte Einschränkungen der PEIQ API Anbindung

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

https://peiq.atlassian.net/browse/PORTAL-44

Modul im Einsatz bei

[SGU] (stadtanzeiger-ortenau.de)

Status

colour	Green
title	Online (V2)

Trouble Shooting bei HTTP Status Codes

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Note

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
Status
colour Green
title extern

Note
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?

Excerpt

Details
Status
colour Green
title extern

Note
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).

Excerpt

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

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

Code Block

{
  "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

Code Block

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
Status
colour Green
title extern

Excerpt

Monat 202X - Zusammenfassung

Text

Excerpt

Monat 202X - Zusammenfassung

Text

Anleitung zum Setup
Status
colour Green
title extern

Excerpt

Historie

change-history

Include Page

	Disclaimer der PEIQ PORTAL - Produktdokumentation
	Disclaimer der PEIQ PORTAL - Produktdokumentation

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

Version	Old Version 1	New Version Current
Changes made by	Boris Braun	Ilker Oygün
Saved on	2020-09-27	2024-10-25

Versions Compared

Key

Zusammenfassung

Inhaltsverzeichnis

Interne Beschreibung

Basis URL

Allgemeine Beschreibung

Verfügbare Endpunkte

Classified Ad

Response

Request Body

HTTP Status Codes

Verfügbare Endpunkte für Classified Ad Categories

Verfügbare Endpunkte für Classified Ad Categories

Response

HTTP Status Codes

Setup & Konfiguration

Konfigurationsparameter

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Verwandte Themen

Trouble Shooting bei HTTP Status Codes

`400` - Bad Request

`404` - Not Found

Verwandte Themen

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Allgemeine Beschreibung
Status
colour Green
title extern

Details
Status
colour Green
title extern

Die Basis URL

Verfügbare Endpunkte für Classified Ads

Verfügbare Endpunkte für Classified Ad Categories

Release-Notes
Status
colour Green
title extern

Monat 202X - Zusammenfassung

Monat 202X - Zusammenfassung

Anleitung zum Setup
Status
colour Green
title extern

Historie

Page Comparison

Versions Compared

Key

Zusammenfassung

Inhaltsverzeichnis

Interne Beschreibung

Basis URL

Allgemeine Beschreibung

Verfügbare Endpunkte

Classified Ad

Response

Request Body

HTTP Status Codes

Verfügbare Endpunkte für Classified Ad Categories

Verfügbare Endpunkte für Classified Ad Categories

Response

HTTP Status Codes

Setup & Konfiguration

Konfigurationsparameter

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Verwandte Themen

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

404 - Not Found

Verwandte Themen

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten StatuscolourGreentitleextern

Allgemeine Beschreibung StatuscolourGreentitleextern

Details StatuscolourGreentitleextern

Die Basis URL

Verfügbare Endpunkte für Classified Ads

Verfügbare Endpunkte für Classified Ad Categories

Release-Notes StatuscolourGreentitleextern

Monat 202X - Zusammenfassung

Monat 202X - Zusammenfassung

Anleitung zum Setup StatuscolourGreentitleextern

Historie

`400` - Bad Request

`404` - Not Found

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Allgemeine Beschreibung
Status
colour Green
title extern

Details
Status
colour Green
title extern

Release-Notes
Status
colour Green
title extern

Anleitung zum Setup
Status
colour Green
title extern