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.
Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert.
Funktionalitäten der Veranstaltungskalender API
Auslesen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Anlegen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Ändern der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Löschen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Inhaltsverzeichnis
Allgemeine Beschreibung
Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=eventcalendar erreichbar.
Das swagger-File kann auch hier heruntergeladen werden (Stand: ):
Verfügbare Endpunkte
Eventitem
Veranstaltungen werden vom System als Eventitems bezeichnet. Ein Eventitem enthält verschiedene Parameter zur Festlegung der Orte und der Zeitpunkte der Veranstaltung. Es sind mehrere Veranstaltungsorte sowie mehrere Zeitpunkte der Veranstaltungen (=Termine) pro Eventitem möglich.
GET ​/eventitems: Gibt eine paginierte Liste an Veranstaltungen nach den gesetzten Filtern aus.
GET /eventitems/{eventitem_id}: Gibt die durch die ID spezifizierte Veranstaltung zurück.
POST /eventitems: Erstellt eine neue Veranstaltung.
PUT /eventitems/{eventitem_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Veranstaltung.
DELETE /eventitems/{eventitem_id}: Löscht die durch die ID spezifizierte Veranstaltung unwiderruflich.
Das PORTAL prüft bei der Beitrags API sowie bei der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 nicht dahingehend, ob die gesendete remote_ID eindeutig ist. Dies müssen die angeschlossenen Systeme selbst sicherstellen. Sofern die gleiche Remote-ID an mehreren Inhalten vergeben ist, berücksichtigt ein Request mithilfe der remote_ID immer nur ein Item (in der Regel das erste Item in der nach der ID aufsteigend sortierten Liste).
Eventitem Category
GET /eventitems/categories: Gibt eine Liste der im PORTAL hinterlegten Kategorien für Veranstaltungen zurück (Informationen:
id,name,name_norm).GET /eventitems/categories/{category_id}: Gibt die durch die ID spezifizierten Kategorie für Veranstaltungen zurück (Informationen:
id,name,name_norm).
Eventitem Comment
GET /eventitems/{eventitem_id}/comments: Gibt die Kommentare der durch die ID spezifizierten Veranstaltung zurück.
POST /eventitems/{eventitem_id}/comments: Erstellt einen Kommentar an der durch die ID spezifizierten Veranstaltung.
PUT /eventitems/comments/{comment_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Kommentars.
DELETE /eventitems/comments/{comment_id}: Löscht den durch die ID spezifizierten Kommentar.
Eventitem Image
GET /eventitems/{eventitem_id}/images: Gibt alle Bilder der durch die ID spezifizierten Veranstaltung zurück.
GET /eventitems/images/{image_id}: Gibt das durch die ID spezifizierte Bild einer Veranstaltung zurück.
POST /eventitems/{eventitem_id}/images: Fügt ein oder mehrere Bilder (
array) einer durch die ID spezifizierten Veranstaltung hinzu.PUT /eventitems/images/{image_id}: Aktualisiert die Meta-Informationen (hochgeladen von, Copyright, Bildunterschrift, Bildfokus) des durch die ID spezifizierten Bildes.
DELETE /eventitems/images/{image_id}: Löscht das durch die ID spezifizierte Bild einer Veranstaltung unwiderruflich.
Bilder werden asynchron importiert.
Bilder müssen für einen Import in das PORTAL von einer öffentlich zugänglichen URL abrufbar sein. Die Bilder können nicht direkt in das PORTAL eingespeist werden. Dies ist eine Maßnahme zur besseren Skalierbarkeit, um das System, bzw. die Schnittstelle nicht zu überlasten und eine schnelle Verarbeitung der Importe zu gewährleisten.
Bei den image-Endpunkten der Beitrags API und der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 wird nur die ID des articles / des eventimtems unterstützt: Die remote-ID von Beiträgen / Veranstaltungen kann also in den Request-URLs für GET , PUT und DELETE bei den image-Endpunkten nicht genutzt werden.
Stattdessen kann die remote-ID des Beitrags / der Veranstaltung im GET -Endpunkt genutzt werden, um die ID des articles / des eventitems zu erhalten, welche dann in den image-Endpunkten verwendet werden kann.
Beachte auch die Hinweise hier: https://peiq.atlassian.net/wiki/spaces/CORE/pages/44400763/API+Cloud-Connect#Fragen-zu-Bilder-Workflows-%C3%BCber-die-APIs
Wichtige Hinweise zu Embeds, HTML- & BBCode-Tags im Text bei Importen
Siehe die entsprechende Dokumentation: Verwendung von HTML- & BBCode-Tags bei Importen
Wichtige Hinweise zur remote_id
Das PORTAL prüft bei der Beitrags API sowie bei der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 nicht dahingehend, ob die gesendete remote_ID eindeutig ist. Dies müssen die angeschlossenen Systeme selbst sicherstellen. Sofern die gleiche remote-ID an mehreren Inhalten vergeben ist, berücksichtigt ein Request mithilfe der remote_ID immer nur ein Item (in der Regel das erste Item in der nach der ID aufsteigend sortierten Liste).
Bei den image-Endpunkten der Beitrags API und der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 wird nur die ID des articles / des eventimtems unterstützt: Die remote-ID von Beiträgen / Veranstaltungen kann also in den Request-URLs für GET , PUT und DELETE bei den image-Endpunkten nicht genutzt werden.
Stattdessen kann die remote-ID des Beitrags / der Veranstaltung im GET -Endpunkt genutzt werden, um die ID des articles / des eventitems zu erhalten, welche dann in den image-Endpunkten verwendet werden kann.
Trouble Shooting bei HTTP Status Codes
Verwandte Seiten
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.