Versions Compared

Old Version 12

changes.mady.by.user Kathrin Janka

Saved on

compared with

New Version Current

changes.mady.by.user Kathrin Janka

Saved on

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.

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

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

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: ):

View file
nameapi_module_eventcalendar_swagger.json

 

 

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.

  • Status
    colourBlue
    titleGET
    ​/eventitems: Gibt eine paginierte Liste an Veranstaltungen nach den gesetzten Filtern aus.

  • Status
    colourBlue
    titleGET
    /eventitems/{eventitem_id}: Gibt die durch die ID spezifizierte Veranstaltung zurück.

  • Status
    colourGreen
    titlePOST
    /eventitems: Erstellt eine neue Veranstaltung.

  • Status
    colourYellow
    titlePUT
    /eventitems/{eventitem_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Veranstaltung.

  • Status
    colourRed
    titleDELETE
    /eventitems/{eventitem_id}: Löscht die durch die ID spezifizierte Veranstaltung unwiderruflich.

Note

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

  • Status
    colourBlue
    titleGET
    /eventitems/categories: Gibt eine Liste der im PORTAL hinterlegten Kategorien für Veranstaltungen zurück (Informationen: id, name, name_norm).

  • Status
    colourBlue
    titleGET
    /eventitems/categories/{category_id}: Gibt die durch die ID spezifizierten Kategorie für Veranstaltungen zurück (Informationen: id, name, name_norm).

Eventitem Comment

  • Status
    colourBlue
    titleGET
    /eventitems/{eventitem_id}/comments: Gibt die Kommentare der durch die ID spezifizierten Veranstaltung zurück.

  • Status
    colourGreen
    titlePOST
    /eventitems/{eventitem_id}/comments: Erstellt einen Kommentar an der durch die ID spezifizierten Veranstaltung.

  • Status
    colourYellow
    titlePUT
    /eventitems/comments/{comment_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Kommentars.

  • Status
    colourRed
    titleDELETE
    /eventitems/comments/{comment_id}: Löscht den durch die ID spezifizierten Kommentar.

Eventitem Image

  • Status
    colourBlue
    titleGET
    /eventitems/{eventitem_id}/images: Gibt alle Bilder der durch die ID spezifizierten Veranstaltung zurück.

  • Status
    colourBlue
    titleGET
    /eventitems/images/{image_id}: Gibt das durch die ID spezifizierte Bild einer Veranstaltung zurück.

  • Status
    colourGreen
    titlePOST
    /eventitems/{eventitem_id}/images: Fügt ein oder mehrere Bilder (array) einer durch die ID spezifizierten Veranstaltung hinzu.

  • Status
    colourYellow
    titlePUT
    /eventitems/images/{image_id}: Aktualisiert die Meta-Informationen (hochgeladen von, Copyright, Bildunterschrift, Bildfokus) des durch die ID spezifizierten Bildes.

  • Status
    colourRed
    titleDELETE
    /eventitems/images/{image_id}: Löscht das durch die ID spezifizierte Bild einer Veranstaltung unwiderruflich.

Note

Bilder werden asynchron importiert.

Note

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.

Note

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

Status
colourBlue
titleGET
,
Status
colourYellow
titlePUT
und
Status
colourRed
titleDELETE
bei den image-Endpunkten nicht genutzt werden.

Stattdessen kann die remote-ID des Beitrags / der Veranstaltung im

Status
colourBlue
titleGET
-Endpunkt genutzt werden, um die ID des articles / des eventitems zu erhalten, welche dann in den image-Endpunkten verwendet werden kann.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#F4F5F7

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

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#F4F5F7

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

Status
colourBlue
titleGET
,
Status
colourYellow
titlePUT
und
Status
colourRed
titleDELETE
bei den image-Endpunkten nicht genutzt werden.

Stattdessen kann die remote-ID des Beitrags / der Veranstaltung im

Status
colourBlue
titleGET
-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

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 Seiten

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel = "api" and space = "PUPKB"

Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation