Versions Compared

Key

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

Transportverfahren

Übertragung per Restful API (https)

Objekt

Artikel im JSON und Bilder als strukturiertes Objekt im JSON, Artikel-ID als eindeutiges Merkmal (document ID)

Trigger

Zeitlich gesteuerter Poll durch PRINT NGEN (Pull alle 15 Sekunden, sofern vorhergehender Pull durchgeführt), Artikel-ID = eindeutiges Merkmal

Typische Drittsysteme

Livingdocs

...

Feld

Inhalt

Option

"id"

ID des Elements im Artikel

-

"component"

Element des Artikels, z. B.:

  • image → Bild

  • head oder header → Kopf

  • (lead-p → Vorspann)

  • p → Standard-Text

-

"content": { component: "image", “content”: { “image”: { "originalUrl" }}}

URL des Original-Bildes

erforderlich

"content": { component: "image", “content”: { “image”: { "url" }}}

URL des platzierten Bildes

optional

"content": { component: "image", “content”: { “image”: { "width" }}}

Breite des Bildes

-

"content": { component: "image", “content”: { “image”: { "height" }}}

Höhe des Bildes

-

"content": { component: "image", “content”: { “image”: { "mimeTyp" }}}

image/jpeg

-

"content": { component: "image", “content”: { “image”: { "imageService" }}}

imgix

-

"content": { component: "image", “content”: { “image”: { "origins": { "name" }}}}

Ursprung/Quelle des Bildes z. B. hugo

optional

"content": { component: "image", “content”: { “image”: { "origins": { "identifier" }}}}

Bild-ID


optional

"content": { component: "image", “content”: { “image”: { "crop": { "x" }}}}

X-Koordinate des Ausschnitts von links oben

-

"content": { component: "image", “content”: { “image”: { "crop": { "y" }}}}

Y-Koordinate des Ausschnitts von links oben

-

"content": { component: "image", “content”: { “image”: { "crop": { "width" }}}}

Breite des Ausschnitts

optional

"content": { component: "image", “content”: { “image”: { "crop": { "height" }}}}

Höhe des Ausschnitts

optional

"content": { component: "image", “content”: { “image”: { "crop": { "name" }}}}

Bezeichnung des Ausschnitts z. B. 16:9

optional

"content": { component: "image", “content”: { “image”: { "caption" }}}

Bildunterschrift

optional

"content": { component: "image", “content”: { “image”: { "source" }}}

Bildquelle

optional

"content": { component: "head" oder: "header", content: { "catchline" }}

Dachzeile des Artikels

optional

"content": { component: "head" oder: "header", content: { "title" }}

Titel des Artikels

erforderlich

"content": { component: "head" oder: "header", content: { "lead" }}

Unterzeile des Artikels

optional

"content": { component: "head" oder: "header", content: { "author" }}

Autor:in des Artikels

optional

"content": { component: "head" oder: "header", content: { "authorShortnames" }}

Autor:innenkürzel

optional

"content": { component: "head" oder: "header", content: { "city" }}

Ort des Artikels

optional

"content": { component: "lead-p", content: { "text" }}

Vorspann des Artikels

optional

"position"

z. B. fixed

-

"content": { component: "p", content: { "text" }}

Absatz eines Artikels

optional

"content": { component: “subtitle”, “content“: { “title“ }}

Zwischentitel im Artikel

optional

"content": { component: “list”, “containers”: { “list” }}

Liste im Artikel

optional

"content": { component: “list” , “containers”: { “list”: [{ “component”: “list-item”, “content”: { “text” }}]}}

Listenelement

optional

"content": { component: “quote” , “content”: { “text” }}

Zitat im Artikel

optional

"content": { component: “quote” , “content”: { “source” }}

Autor:in/Quelle des Zitats

optional

"content": { component: "question" , "content": { "text" }}

Frage

optional

"content": { component: "answer" , "content": { "text" }}

Antwort

optional

"content": {"component": "infobox",
"content": {

"title": "",

"text": "",

"image": ""
{}}}

Infobox im Artikel (in PRINT NGEN als eigenständiger Artikel) mit oder ohne Bild.

Im Text sind Auszeichnungen (strong, em, p) möglich. Weitere Components (list, quote, question, answer) dürfen im Text nicht übergeben werden.

Für Infoboxbilder können die gleichen Felder übergeben werden wie bei den Artikelbildern.

optional

Die Schnittstelle liefert an PRINT NGEN die Artikel-JSONs zurück, z. B.:

...

Include Page
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation

Nur für PEIQ Mitarbeiter:innen:

[0-17] INBOUND Living-Docs API | Artikel mit Bilder