Versions Compared

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 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 Set-up angelegten Print-Produkte des Kleinanzeigenmarkts abgerufen werden.

Funktionalitäten der Printprodukte (Kleinanzeigen) API

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

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Allgemeine Beschreibung

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

 

 

Verfügbare Endpunkte

Print Products

  • Status
    colourBlue
    titleGET
    /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
    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
    titlePOST
    /print/product/{product_id}/issues: Erstellt eine neue Ausgabe für das durch die ID spezifizierte Printprodukt.

  • Status
    colourRed
    titleDELETE
    /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 in ( = "api" , "api-dokumentation" , "schnittstellen" , "schnittstellen-pps" ) and space = "PPSDPUPKB"

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