PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

NICHT BEARBEITET

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

GET, POST, DELETE

Anbieter

PEIQ

Syntax

Kleinanzeigen-API

Über diesen Endpunkt können die von PEIQ beim Setup angelegten Print-Produkte des Kleinanzeigenmarkt abgerufen werden.

Produkt (Label)

Portal

Übergeordnetes Modul (Label)

API, Kleinanzeigen

Inhaltsverzeichnis

 Inhaltsverzeichnis anzeigen

Interne Beschreibung

Basis URL

https://yourdomain.com/api/v2/print/products/{product_id}

Je nach Auslegung des Kleinanzeigenmarkts und der allgemeinen Aufstellung des Verlags kann ein Verlag ein oder mehrere Printprodukte (unterschiedliche Zeitungen) haben. Über diesen Endpunkt können die von PEIQ beim Setup angelegten Print-Produkte abgerufen werden.

Verfügbare Endpunkte für Print Products

GET

  • Get All Print Products

  • Get All Print Products by product_id

    • product_id

Response

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "id": "1",
      "name": "Stadtzeitung Augsburg",
      "name_norm": "stadtzeitung-augsburg"
    }
  ]
}

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 - Print Product Not Found    Das Produkt mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Print Product Issues

https://yourdomain.com/api/v2/print/products/{product_id}/issues/{issue_id}

Former user (Deleted) was genau sind hier die Issues?

GET

  • Get All Print Product Issues by Filters

    • publish_status (Available values : published, unpublished)

  • Get Print Product Isse by issue_id

    • issue_id

Response

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "id": "1",
      "name": "Stadtzeitung Augsburg",
      "publish_date": "2019-03-01T00:00:00+00:00",
      "closing_date": "2019-03-31T23:59:59+00:00"
    }
  ]
}

POST

  • Create Print Product Issues

DELETE

  • Delete Print Product Issue

    • issue_id

Request Body

[
  {
    "name": "Stadtzeitung Augsburg",
    "publish_date": "2019-03-01T00:00:00+00:00",
    "closing_date": "2019-03-31T23:59:59+00:00"
  }
]

HTTP Status Codes

200 - Success                    Alles hat wie erwartet funktioniert
201 - Print Product Issues successfully created
204 - Print Product Issue successfully deleted
400 - Bad Reqest                 Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Print Product Not Found    Das Produkt mit der angegebenen ID scheint nicht zu existieren

Workflow

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

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

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

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

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:55 Boris Braun
v. 13 2024-02-09 14:48 Kathrin Janka
v. 12 2024-02-08 14:34 Kathrin Janka
v. 11 2022-08-18 10:11 Former user
v. 10 2022-08-18 08:49 Former user
v. 9 2022-08-18 08:44 Former user
v. 8 2022-03-15 15:26 Former user
v. 7 2020-11-17 16:06 Franziska Franz
v. 6 2020-10-27 15:20 Former user
v. 5 2020-10-22 05:06 Franziska Franz
v. 4 2020-10-06 08:51 Boris Braun
v. 3 2020-09-28 09:12 Boris Braun
v. 2 2020-09-28 09:12 Boris Braun
v. 1 2020-09-27 08:55 Boris Braun

  • No labels

Impressum