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

« Previous Version 9 Next »

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

 Inhaltsverzeichnis anzeigen

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 Set-up 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}

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

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

Der Request war nicht akzeptabel.

Das liegt oft an einem fehlenden Parameter. Hier ist der gesendete Request Body zu prüfen.

Eine weitere Ursache bei GET -Requests ist das harte Limit von maximal 10.000 Results. Wir empfehlen daher, die Abfragen noch weiter einzugrenzen, z. B. monats- oder ortsweise, um so die Grenze zu umgehen.

404 - Not Found

Der gesuchte Inhalt konnte nicht gefunden werden bzw. die gesetzten Filter finden keine Ergebnisse.

Verwandte Themen

Disclaimer

Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.

  • No labels