Versions Compared

Old Version 21

changes.mady.by.user Former user

Saved on

compared with

New Version 22

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 Article Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Beiträgen, von Schnappschüssen sowie von Kommentaren zu Beiträgen oder Schnappschüssen verwendet werden. Zudem können mithilfe der API Medienstreams mit Beiträgen verknüpft und als Hero-Image gesetzt werden. Bilder werden asynchron importiert. 

Funktionalitäten der Beitrags API

  • Abrufen, Erstellen, Editieren und Löschen von Beiträgen nach verschiedenen Filtern

  • Abrufen, Erstellen, Editieren und Löschen von Schnappschüssen nach verschiedenen Filtern

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=article erreichbar.

Das swagger-File kann auch hier heruntergeladen werden (Stand: ):

View file
nameapi_module_article_swagger.json

 

Verfügbare Endpunkte

Article

  • Status
    colourBlue
    titleGET
    /articles: Gibt eine paginierte Liste an Beiträgen nach den gesetzten Filtern aus.

  • Status
    colourBlue
    titleGET
    /articles/{article_id}: Gibt den durch die ID spezifizierten Beitrag zurück.

  • Status
    colourGreen
    titlePOST
    /articles: Erstellt einen neuen Beitrag.

  • Status
    colourYellow
    titlePUT
    /articles/{article_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Beitrags.

  • Status
    colourRed
    titleDELETE
    /articles/{article_id}: Löscht den durch die ID spezifizierten Beitrag unwiderruflich.

Article Category

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

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

Article Comment

  • Status
    colourBlue
    titleGET
    /articles/{article_id}/comments: Gibt die Kommentare des durch die ID spezifizierten Beitrags zurück.

  • Status
    colourGreen
    titlePOST
    /articles/{article_id}/comments: Erstellt einen Kommentar am durch die ID spezifizierten Beitrag.

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

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

Article Image

  • Status
    colourBlue
    titleGET
    /articles/{article_id}/images: Gibt alle Bilder des durch die ID spezifizierten Beitrags zurück

  • Status
    colourBlue
    titleGET
    /articles/images/{image_id}: Gibt das durch die ID spezifizierte Bild eines Beitrags zurück

  • Status
    colourGreen
    titlePOST
    /articles/{article_id}/images: Fügt ein oder mehrere Bilder (array) einem durch die ID spezifizierten Beitrag hinzu

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

  • Status
    colourRed
    titleDELETE
    /articles/images/{image_id}: Löscht das durch durch die ID spezifizierte Bild eines Beitrags unwiderruflich.

Note

Bilder werden asynchron importiert.

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

Imagepost

  • Status
    colourBlue
    titleGET
    /imageposts: Gibt eine paginierte Liste an Schnappschüssen nach den gesetzten Filtern aus

  • Status
    colourBlue
    titleGET
    /imageposts/{imagepost_id}: Gibt den durch die ID spezifizierten Schnappschuss zurück

  • Status
    colourGreen
    titlePOST
    /imageposts: Erstellt einen neuen Schnappschuss

  • Status
    colourYellow
    titlePUT
    /imageposts/{imagepost_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Schnappschusses.

  • Status
    colourRed
    titleDELETE
    /imageposts/{imagepost_id}: Löscht den durch die ID spezifizierten Schnappschuss unwiderruflich.

Imagepost Comment

  • Status
    colourBlue
    titleGET
    /imageposts/{imagepost_id}/comments: Gibt die Kommentare des durch die ID spezifizierten Schnapsschusses zurück

  • Status
    colourGreen
    titlePOST
    /imageposts/{imagepost_id}/comments: Erstellt einen Kommentar am durch die ID spezifizierten Schnappschuss

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

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

Wichtige Hinweise zum Setzen des Hero-Images

Mit der Beitrags API gibt es die Möglichkeit, auch Medienstreams mit Beiträgen zu verknüpfen sowie als Hero-Image zu setzen.

In diesem Zuge wurde das bisherige thumbnail als

Status
colourRed
titleDEPRECATED
markiert. Zusätzlich wurde hero_image eingeführt, welches sowohl das erste Bild des Beitrags als Vorschaubild, als auch das Vorschaubild des Medienstreams (sofern entsprechend angegeben) als Hero-Image abbilden kann. thumbnail wird von zukünftigen Versionen nicht mehr unterstützt werden.

Wichtige Hinweise zu Embeds, HTML- & BBCode-Tags im Text bei Importen

Siehe die entsprechende Dokumentation:

Verwendung von HTML- & BBCode-Tags bei Importen

Wichtige Hinweise zu search_string-Filter bei
Status
colourBlue
titleGET
/articles

Der Filter search_string bei

Status
colourBlue
titleGET
/articles verhält sich analog der Suche in der Beitragsverwaltung mit den Einstellungen “Diese Wörter” und “mit Beitrags-Text”. Wird nach einem search_string gefiltert, gibt die API zusätzlich die search_highlights aus. Damit können die Snippets und die Highlight-Markierung, die aus der Suche in der Beitragsverwaltung bekannt sind, auch externen Systemen zur Verarbeitung zur Verfügung gestellt werden.

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 in ( = "api" , "api-dokumentation" , "schnittstellen" ) and space = "PPSDPUPKB"

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