Versions Compared

Old Version 1

changes.mady.by.user Boris Braun

Saved on

compared with

New Version Current

changes.mady.by.user Ilker Oygün

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourRed
titlenicht bearbeitet

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

GET, POST, DELETE

Anbieter

PEIQ

Syntax

Kleinanzeigen-API

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

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

Produkt

Funktionalitäten der Printprodukte (

Label

Kleinanzeigen)

Portal

Übergeordnetes Modul (Label)

API, Kleinanzeigen

API

  • Abrufen der von PEIQ beim Set-up angelegten Print-Produkte des Kleinanzeigenmarkts

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Interne Beschreibung

Basis URL

Code Block
languagetext
https://yourdomain.com

Allgemeine Beschreibung

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/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

doc?module=print erreichbar.

Das swagger-File kann auch hier heruntergeladen werden (Stand: ):

View file
nameapi_module_print_swagger.json

 

Image Added

 

Verfügbare Endpunkte

Print Products

HTTP Status Codes

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

Code Blockhttps://yourdomain.com/api/v2

  • Status
    colourBlue
    titleGET

  • Get All Print Products

  • Get All Print Products by product_id

    • product_id

Response

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

  • /print/products: Gibt eine paginierte Liste an Printprodukten (Kleinanzeigen) nach den gesetzten Filtern aus.

  • Status
    colourBlue
    titleGET
    /print/products/{product_id}

/issues/{issue_id}Former user (Deleted) was genau sind hier die Issues?

  • : Gibt das durch die ID spezifizierte Printprodukt (Kleinanzeigen) zurück.

Print Product Issues

  • Status
    colourBlue
    title

get

  • Get All Print Product Issues by Filters

    • publish_status (Available values : published, unpublished)

  • Get Print Product Isse by issue_id

    • issue_id

Response

Code Block
languagejson
{ "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" } ] }Create Print Product Issues

  • GET
    /print/issues/{issue_id}: Gibt die durch die ID spezifizierte Ausgabe zurück.

  • Status
    colourBlue
    titleGET
    /print/products/{product_id}/issues: Gibt eine paginierte Liste aller Ausgaben des durch die ID spezifizierten Printproduktes, optional nach den gesetzten Filtern aus.

  • Status
    colourGreen
    title

post

Konfigurationsparameter

Warning

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

Bekannte Einschränkungen

Note

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

  • [SGU] (stadtanzeiger-ortenau.de)

    Status
    colourGreen
    titleOnline (V2)

    • Verwandte Themen

    Verwandte Seiten

    Filter by label (Content by label)showLabelsfalseshowSpace

    • POST
      /print/product/{product_id}/issues: Erstellt eine neue Ausgabe für das durch die ID spezifizierte Printprodukt.

    • Status
      colourRed
      title

    delete

    • Delete Print Product Issue

      • issue_id

    Request Body

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

    HTTP Status Codes

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

     

    • DELETE
      /print/issues/{issue_id}: Löscht die durch die ID spezifizierte Ausgabe unwiderruflich.

    Trouble Shooting bei HTTP Status Codes

    400 - Bad Request

    Insert excerpt
    API 2.0 Dokumentation PORTAL
    API 2.0 Dokumentation PORTAL
    name400
    nopaneltrue

    404 - Not Found

    Insert excerpt
    API 2.0 Dokumentation PORTAL
    API 2.0 Dokumentation PORTAL
    name404
    nopaneltrue

    Verwandte Themen

    Filter by label (Content by label)
    showLabelsfalse
    maxCheckboxfalse
    showSpacefalse
    reversefalse
    cqllabel = "api" and space = "
    CORE
    PUPKB"

    Verwandte Labels

    Related Labels
    labelsAPI, kleinanzeigen

    Ansprechpartner

    Teil 2 - EXTERN für Kunden & Interessenten
    Status
    colourGreen
    titleextern

    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
    colourGreen
    titleextern

    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
    colourGreen
    titleextern

    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

    Release-Notes
    Status
    colourGreen
    titleextern

    Excerpt

    Monat 202X - Zusammenfassung

    Text

    Excerpt

    Monat 202X - Zusammenfassung

    Text

    Anleitung zum Setup
    Status
    colourGreen
    titleextern

    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/RgKgAw