| 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 Setup angelegten Print-Produkte des Kleinanzeigenmarkt abgerufen werden. |
Funktionalitäten der Stellenmarkt Printprodukte (Kleinanzeigen) 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
| Expand | ||||
|---|---|---|---|---|
| ||||
|
Detaillierte Beschreibung
Basis URL
| Code Block | ||
|---|---|---|
| ||
https://yourdomain.com/api/v2/print/products/{product_id} |
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 Setup angelegten Print-Produkte abgerufen werden.
Verfügbare Endpunkte für Print Products
| Status | ||||
|---|---|---|---|---|
|
Get All Print Products
Get All Print Products by product_id
product_id
Response
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
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 | ||||
|---|---|---|---|---|
|
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 | ||
|---|---|---|
| ||
{
"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 | ||||
|---|---|---|---|---|
|
Create Print Product Issues
| Status | ||||
|---|---|---|---|---|
|
Delete Print Product Issue
issue_id
Request Body
| Code Block | ||
|---|---|---|
| ||
[
{
"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 | ||
|---|---|---|
| ||
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.Berechtigte Nutzer
Die Beitrags API ist eine Adminfunktion, welche Nutzer mit der Berechtigung “Zugang zur API-Dokumentation“abrufen dürfen.
Die Interaktive Bedienung - Try it out
Die API 2.0 BETA Dokumentation
ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”kann bereits ohne große Programmierkenntnisse oder ein darauf ausgerichtetes Programm bedient werden. Hierfür gibt es die “Try-it-out” - Funktion.
Jeder Lesende (GET) Endpunkt der Dokumentation hat einen “Try it out” Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion ist ein gültiger API key .
Der 'Try it out' Button
| Note |
|---|
Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die Lesenden Endpunkte (GET) beschränkt. |
Verwandte Themen
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|