[0-21] DAM API - Embeds

Transportverfahren	Übertragung per Restful API (https)
Objekt	Embeds, Datenbanktabelle DEmbed
Trigger	Request durch Drittsystem
Typische Drittsysteme	Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online
Beispieldaten	siehe unten

Hier sind die Embeds-Endpunkte der DAM API beschrieben, mit denen Embeds im NGEN DAM angelegt, abgerufen und geändert werden können. Diese Endpunkte sind nur bei Einsatz von PEIQ CREATE relevant.

Der aktuelle Funktionsumfang kann über folgenden Link eingesehen werden: PEIQ DamAPI

Funktionalitäten

Anlegen von Embeds
Abrufen von Embeds
Update von Embeds

Inhaltsverzeichnis

2 Verwandte Seiten

Anlegen von Embeds

POST /embeds

Über die DAM API können einzelne Embeds angelegt werden. Dazu muss das Embed im body als gültiges JSON übergeben werden.

Beispiel: {baseUrl}/damapi/v1/embeds

{
  "type": "Twitter",
  "external_id": "1426915704062816260",
  "title": "Twitter Embed",
  "url": "https://twitter.com/_Seebruecke_/status/1426915704062816260",
  "html_code": "",
  "keywords": [
    {
      "name": "Twitter",
      "type": "topic",
      "priority": 5
    },
    {
      "name": "Embed",
      "type": "topic",
      "priority": 3
    }
  ],
  "settings": [
    {
      "setting": "width",
      "value": "584"
    },
  ]
}

Abrufen bestimmter Embeds

GET /embeds/{id}

Über die DAM API können einzelne Embeds aus der Datenbank abgefragt werden, die in CREATE angelegt wurden.

Beispiel: {baseUrl}/damapi/v1/embeds/{261-4048935}

Update von Embeds

PUT /embeds/{id}

Über die DAM API können bestimmte Embeds upgedatet werden. Im Body müssen alle Felder, die aktualisiert werden sollen, als gültiges JSON mitgegeben werden. Felder, die nicht angegeben werden, werden nicht verändert.

Beispiel: {baseUrl}/damapi/v1/embeds/{261-4048935}

Metadaten der Embed-Daten, die übertragen werden können:

Beschreibung	DAM-API Feld	NGen Eigenschaft
Embed-Typ	type	DEmbedTyp
Externe ID	external_id	DEmbedExtId
Titel	title	DEmbedTitel
URL	url	DEmbedUrl
Embed-Code	html_code	DEmbedCode
Keywords	keywords	SchlagwortXml
Zusatz-Attribute	settings	DEmbedZusatzAttribute

Anlegen von Embeds

Abrufen bestimmter Embeds

Update von Embeds

Metadaten der Embed-Daten, die übertragen werden können:

Verwandte Seiten