PORTAL und PPS Knowledge Base

Printprodukte (Kleinanzeigen) API

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

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

 

Interaktive Dokumentation im Admin-Bereich des PORTALs

 

Verfügbare Endpunkte

Print Products

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

  • GET /print/products/{product_id}: Gibt das durch die ID spezifizierte Printprodukt (Kleinanzeigen) zurück.

Print Product Issues

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

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

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

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

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

404 - Not Found

Verwandte Themen