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

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

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

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 Block
https://yourdomain.com/api/v2/print/products/{product_id}/issues/{issue_id}

Status
colourBlue
titleget

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

Status
colourGreen
titlepost

  • Create Print Product Issues

Status
colourRed
titledelete

  • 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

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
showSpacefalse
cqllabel in ( "api" , "api-dokumentation" , "schnittstellen" , "schnittstellen-pps" ) and space = "PPSD"
Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation