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 Setup angelegten Print-Produkte des Kleinanzeigenmarkt abgerufen werden.
Funktionalitäten der Stellenmarkt API
Zum Abrufen der von PEIQ beim Setup angelegten Print-Produkte des Kleinanzeigenmarkt .
Es handelt sich bei der Printprofukte-Kleinanzeigen-API um eine Public API
Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.
Inhaltsverzeichnis
Detaillierte Beschreibung
Basis URL
https://yourdomain.com/api/v2/print/products/{product_id}
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 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
Setup & Konfiguration
Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”