Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Transportverfahren

Übertragung per Restful API (https)

Objekt

PRINT NGEN Artikel und Seiten

Trigger

Request durch Drittsystem

Typische Drittsysteme

Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online

Beispieldaten

siehe unten

...

  • {baseUrl}/articels/search?projectId=Print&limit=50&offset=20210714-13:42:41/1-16059606

Preview von gespeicherten Artikeln: GET /articles/preview/{id}/{resolution}/{page_id} (kundenspezifisch)

Ist die NGEN-CID eines Artikels bekannt, kann die Vorschau dieses Artikels abgerufen werden. Hier gibt es folgende Möglichkeiten:

  • Der Artikel ist noch nicht platziert und es soll daher die Vorschau des unplatzierten Artikels abgerufen werden. Die Abfrage erfolgt hier mit GET /articles/preview/{id}/{resolution}, wobei es sich bei der id um die CID des Artikels handelt.

  • Der Artikel ist bereits auf einer oder mehreren Seiten platziert und es soll die Vorschau des Artikels von einer Seite abgerufen werden. Die Abfrage erfolgt hier mit GET /articles/preview/{id}/{resolution}/{page_id}, wobei es sich bei der id um die CID des Artikels handelt. Mit page_id muss die CID der Seite mitgegeben werden, auf der der Artikel platziert ist und von der die Vorschau des Artikels abgerufen werden soll.

  • Der Artikel ist bereits platziert, die Seiten-CID ist jedoch nicht bekannt. Die Abfrage erfolgt hier mit GET /articles/preview/{id}/{resolution}, wobei es sich bei der id um die CID des Artikels handelt. Ist der Artikel auf mehreren Seiten platziert, wird das Layout des Artikels auf der ersten gefundenen Seite zurückgeliefert.

Als resolution Für den Parameter “resolution” können beim Request folgende Werte mitgegeben werden:

...

Die Pixelanzahl ist hier die Breite des Bildes.

Preview von gerenderten Artikeln: GET /articles/preview/json/{resolution} (kundenspezifisch)

Artikel, die im externen Editor als Artikelhülle geplant werden, oder noch in Bearbeitung befindliche Artikel können über die Print API angeliefert und in PRINT NGEN auf einer Seite mit dem gewünschten Ziellayout platziert werden.

Für diese Artikel kann auf Grundlage eines im Request-Body mitgelieferten Textes ein Preview generiert werden, bei dem der mitgelieferte Text in das platzierte Artikellayout umbrochen wird. Somit kann der Artikel in einem headless-Modus auf Zeile angepasst werden, sodass er in dieses Artikellayout hineinpasst.

Der mitgelieferte Text dient nur zur Generierung des Previews. Der Text wird nicht am Artikel gespeichert. Wurde der Text so angepasst, dass er gemäß Preview in das Layout hineinpasst, kann dieser Text über den Endpunkt POST /articles/json nach NGEN übergeben werden.

Für den Parameter “resolution” können beim Request die gleichen Werte wie beim Preview von gespeicherten Artikeln mitgegeben werden (thumb, lowRes, midRes, highRes).

Neben dem Artikelinhalt unter “articlecontent” werden im JSON auch die externe ID des Artikels und die Publikation des Artikels, für die das Preview generiert werden soll, übergeben. Falls mehrere Publikationen übergeben werden, wird das Preview für die erste Publikation generiert, die auf einer Seite platziert ist. 

Die Response besteht aus drei Teilen (image, article, page).

Unter "image":{"data"} wird das Preview in Base64-Codierung zurückgegeben.

Unter "article":{"id"} wird die CID für NGEN Artikel, für den das Preview generiert wurde, ausgegeben. Unter "article":{"changeable"} wird zurückgegeben, ob der Artikel mit POST /articles/json aktualisiert werden kann. Bei changeable=false kann der Artikel nicht mehr upgedatet werden!

Unter "page":{"id"} wird die CID der Seite zurückgegeben, auf dem der betreffende Artikel platziert ist, und in dessen Layout der Text umbrochen wurde.

Wenn keines der übergebenen Publications auf einer Seite platziert ist, wird kein Preview generiert. Es wird der HTTP-Fehler 400 (Bad Request) zurückgegeben.

Einschränkungen:

  • Das Preview wird statisch für den übergebenen Text generiert. Es werden keine dynamischen Layoutanpassungen innerhalb des Artikel-Containers vorgenommen. Das bedeutet:

    • Neue Bereiche, die noch nicht im Layout enthalten sind, werden nicht angezeigt (z.B. neuer Vorspann-Bereich)

    • Wenn platzierte Bereiche im übergebenen Text rausfallen, bleibt im Preview eine Lücke für den Bereich bestehen

  • Es werden keine Bilder und BUs geändert. Es werden im Preview die bereits platzierten Bilder angezeigt.

  • Im Preview werden keine Hinweise zu nicht passender Orthografie angezeigt. Eine Rechtschreibprüfung findet nicht statt und muss im Editor selbst erfolgen.

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel in ( "schnittstellen-ngen" , "api-dokumentation" , "api" , "print-ngen" ) and space = "PPSD"
Include Page
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation

Nur für PEIQ-Mitarbeiter:

https://peiq.atlassian.net/wiki/x/cACZY