Versions Compared

Old Version 5

changes.mady.by.user Franziska Franz

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

Funktionalitäten der Printprodukte (Kleinanzeigen) API

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

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4
Detaillierte

Allgemeine Beschreibung

Grundlegendes zur Printpodukte (Kleinanzeigen) API

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

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/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/print/products/{product_id}

  • 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}: Gibt das durch die ID spezifizierte Printprodukt (Kleinanzeigen) zurück.

Print Product Issues

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

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

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

Berechtigte Nutzer

Die Beitrags API ist eine Adminfunktion, welche Nutzer mit der Berechtigung “Zugang zur API-Dokumentation“abrufen dürfen.

Die Interaktive Bedienung - Try it out

Die API 2.0 BETA Dokumentation kann bereits ohne große Programmierkenntnisse oder ein darauf ausgerichtetes Programm bedient werden. Hierfür gibt es die “Try-it-out” - Funktion.

Jeder Lesende (GET) Endpunkt der Dokumentation hat einen “Try it out” Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion ist ein gültiger API key .

Image Removed

 Der 'Try it out' Button

Note

Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die Lesenden Endpunkte (GET) beschränkt.

 

Verwandte Themen

Filter by label (Content by label)showLabelsfalseshowSpacefalsecqllabel in ( "api" , "api-dokumentation" , "schnittstellen" , "schnittstellen-pps" ) and space = "PPSD"

  • 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"
  }
]

  • 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 = "PUPKB"

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