...
Transportverfahren | Übertragung per Restful API (https) |
---|---|
Objekt | Embeds, Bilder, PRINT NGEN-ID und Hash-Wert als eindeutige Merkmale |
Trigger | Request durch Drittsystem |
Typische Drittsysteme | Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online |
Beispieldaten | siehe unten |
Info |
---|
Mit der hier beschriebenen Exportfunktion können Embeds abgefragt, angelegt und geupdatet sowie Bilder durch Dritte via Restful API gesucht (Ergebnisliste mit Metadaten und Preview-Link) und Bilder in verschiedenen Auflösungen von PRINT NGEN in das Drittsystem exportiert werden. |
...
Mit der hier beschriebenen Exportfunktion können Bilder durch Dritte via Restful API abgefragt und in verschiedenen Auflösungen von PRINT NGEN in das Drittsystem exportiert werden.
Weiterhin können Embeds über die API abgefragt, angelegt und geupdatet werden.
Typische Anbindung sind Drittsysteme zur Content-Erstellung für Online.
Der aktuelle Funktionsumfang kann über Swagger UI eingesehen werden:
https://testweb.impulsmt-master-create-test.peiq.cloud/apisdamapi/damapi.html
Austauschformat und Übertragung der Daten
...
Pixeldaten
IPTC-Daten (geänderte Metadaten optional)
Bildunterschrift (optional)
Ort/Stadt (optional)
Kategorien (optional)
Metadaten der Embed-Daten, die übertragen werden können:
Embed-Typ
Externe ID
Titel
URL
Embed-Code
Keywords
Zusatz-Attribute
Empfohlene Verwendung der DAM API
Suche nach bestimmten 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}
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
Code Block |
---|
{
"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"
},
]
} |
Update von Embeds
PUT /embeds/{id}
Über die DAM API können bestimmte Embeds geupdatet 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}
Suche nach bestimmten Bildern
GET /images/search
...
projectId: Bei projectId="create" wird nur eine Suche unter den CREATE-Bildern abgesetzt. Bei proojectIdprojectId="original" wird unter allen Originalbildern (Status in NGen = Original) gesucht
limit: Anzahl der Bilder, die gesucht werden sollen
search: Volltextsuche
categories: Ressort (IptcRes)
services: Dienst (IptcDie)
credit: Objektrecht (IptcOR)
sentFrom: Erstellt ab
sentTo: Erstellt bis
offset oder offsetindex: Gibt an, wie viele Bilder in der Ergebnisliste am Anfang übersprungen werden sollen
...
Wurden z. B. über den E-Paper-Export die beschnittenen Bilder (Hard-Crop) exportiert und die IDs der zugehörigen Originalbilder (unbeschnitten) sind bekannt, können die Originalbilder per DAM API in der gewünschten Auflösung (HighRes, MidRes, LowRes, Thumbnail, Online) abgeholt werden.
Beispiel: {baseUrl}/images/1-16116144/HighRes
...
Beschreibung | DAM-API Feld | NGen Eigenschaft |
ArchivID | archive_id | DBildArchivID |
Caption | caption | Text/ |
ErstelltAm | creation_timestamp | CED |
ErstelltVon | creation_user | CEB |
Bilddateiname | filename | BildDateiName |
Honorarkürzel | honorar_id | DBildHonEmpfaenger |
Objekt | object | DBildObjekt |
Ausgabe | edition | DBildAusgabe |
Bildursprung | origin | BildUrsprung |
OriginalID | original_id | COID |
CID | id | CID |
Autorname | by_line | IptcAN |
Ressort | category | IptcRes |
Ort | location | IptcStadt |
Objektrecht/Copyright | credit | IptcOR |
Land | country | IptcLand |
Aufnahmedatum | date_time_created | IptcED |
Objektname | object_name | IptcON |
Dienst | service_identifier | IptcDie |
Quelle | source | IptcQue |
Kommentar | special_instructions | IptcKom |
Titel/Überschrift | title | IptcUeb |
Priorität | urgency | IptcPri |
Status | status | Status |
BU | underline | Text/BU |
Bildquelle innerhalb der BU | image_source | Text/BU/Bildquelle |
Schlagwörter | keywords
| SchlagwortXml |
GeändertAm | modification_timestamp | CGD |
GeändertVon | modification_user | CGB |
Verwendungshinweis für zurückgezogene Bilder | usage_instructions | DBildVerwendungsHinweis |
Bildbreite in Pixel | width | BildPixelX |
Bildhöhe in Pixel | height | BildPixelY |
SHA1-Wert | sha1 | SHA1 |
Bildausschnitt (wird als relatives Rechteck in 1/10000 Einheiten ausgegeben) | areaimage_region
| BildAusschnitt |
...
Ein Drittsystem kann Bilder über die DAM API nach PRINT NGEN übertragen. Die Bilder laufen als Originalbilder ohne Mindestverschlagwortung ein. Beim Anlegen des Bildes in PRINT NGEN werden die IPTC-Daten der Bilder ausgelesen und in die PRINT NGEN Eigenschaften geschrieben.
Bei der Übertragung des Bildes wird die Dateigröße überprüft. Die maximal zulässige Größe einer hochzuladenden Datei ist 104857600 Bytes (100 MB).
Bevorzugt ein Drittsystem die Übertragung per sFTP gegenüber der Übertragung per API, können Bilder alternativ auch über die Schnittstelle [0-22] INBOUND Bilder (Archiv) übertragen werden. Sollen zudem zu den in der Bilddatei enthaltenen IPTC-Daten auch zusätzliche Metadaten per Metadaten-XML mitgegeben werden bzw. Updates der Bilder bzw. Metadaten erfolgen, können Bilder auch über die Schnittstelle [0-10-4] INBOUND Bilder mit Metadaten-XML übertragen werden.
...
Maßgebliche DB-Tabellen
DBild, DEmbed
Verwandte Seiten
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
...