Transportverfahren | Übertragung per Restful API (https) |
---|---|
Objekt | Bilder, Datenbanktabelle DBild |
Trigger | Request durch Drittsystem |
Typische Drittsysteme | Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online |
Beispieldaten | siehe unten |
Info |
---|
Hier sind die Images-Endpunkte der DAM API beschrieben, mit denen Bilder im PRINT NGEN DAM (= Digital Asset Management) angelegt, gesucht, abgerufen und geändert werden können. Der aktuelle Funktionsumfang kann über folgenden Link eingesehen werden: PEIQ DamAPI |
Funktionalitäten der Images-Endpunkte der DAM API
Anlegen von Bildern
Suche nach Bildern
Abrufen von Wertelisten für die Bildsuche
Abrufen der neusten Bilder
Abrufen der Bilddateien
Abrufen der Bild-Metainformationen
Ändern der Bild-Metainformationen
...
Bei der Übertragung des Bildes wird die Dateigröße überprüft. Die maximal zulässige Größe einer hochzuladenden Datei ist 104857600 beträgt 104.857.600 Bytes (100 MB).
Optional kann im in der URL des Request mit dem Parameter “filename” ein Dateiname mitgegeben werden, der in die PRINT NGEN Eigenschaft BildDateiName “BildDateiName” übernommen wird. Ist beim Dateinamen die Fileextension File-Extension enthalten, wird diese herausgefiltert. Beispiel: {baseUrl}/images?filename=test123.jpg
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.
...
projectId:
Bei projectId="create" wird nur eine Suche unter den CREATE-Bildern abgesetzt.
Bei projectId="original" wird unter allen Originalbildern (Status in NGen PRINT NEGN = Original“Original”) gesucht.
Bei projectId="dam" wird unter allen Original- und Archivbildern (Status in NGen PRINT NGEN = Original “Original” oder Archiviert“Archiviert”) gesucht.
Die Angabe der projectId ist obligatorisch.
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
...
Beim Endpunkt GET /images/search liefern die Ergebnisfelder folgende Inhalte:
id: CID
title: Titel/Überschirft (IptcUeb)
caption: Caption (Text/|TagName!=BU| Text/BU)
category: Ressort (IptcRes)
credit: Objektrecht (IptcOR)
location: Ort (IptcStadt)
width: Bildbreite (BildPixelX)
height: Bildhöhe (BildPixelY)
object: Objekt (DBildObjekt)
edition: Ausgabe (DBildAusgabe)
...
Ein Drittsystem kann eine Liste der Werte für die Suchparameter Ressort (categories“categories”) und Dienst (services“services”) für die anschließende Bildsuche abrufen. Die zurückgegebenen Werte sind nur eine Auswahl der möglichen Suchwerte. Es kann auch mit anderen Werten als den aus der Liste gesucht werden.
Der Endpunkt images/values/categories gibt die Werte der PRINT NGEN Werteliste WL“WL_DBild_IptcRes IptcRes” zurück. Der Endpunkt images/values/services gibt die Werte der Werteliste WL“WL_DBild_IptcDie IptcDie” zurück.
Abrufen der neuesten Bilder
...
projectId
limit
offset: Beim ersten Aufruf wird der Offset nicht angegeben. Dann kommt beim Ergebnis ein Offset zurück, der beim nächsten Aufruf wieder mitgegeben wird, um den nächsten Block aufzusetzen. Der Offset besteht aus der Kombination aus CED und CID eines Startbildes (z. B. "20211117-11:52:58/1-16114101").
Beispiel für den Abruf der ersten 500 Bilder: {baseUrl}/images/latest?projectId=create&limit=500
Beispiel für den Abruf der nächsten 500 Bilder: {baseUrl}/images/latest?projectId=create&limit=500&offset=20210714-13:42:41/1-16059606
offsetindex: Dieser enthält die Zahl der Bilder, die in der Ergebnisliste am Anfang übersprungen werden. Übergibt man also offsetindex“offsetindex=100 100” so werden die ersten 1-100 Bilder nicht mit ausgeliefert, sondern erst ab dem 101. Bild.
Abrufen der Originalbilder
...
Sind die IDs der Bilder bekannt, kann ein Drittsystem folgende Bild-Metainformationen über die DAM API abrufen, um diese auch im Drittsystem z. B. für Bildersuchen zur Verfügung zu haben:
Beschreibung | DAM - API Feld | NGen PRINT 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 |
Bildunterschrift (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) | image_region
| BildAusschnitt |
Beispiel: {baseUrl}/images/1-16116144
Ändern von Metadaten bestehender PRINT NGEN
...
Bilder
PUT /images/{id}
Ein Drittsystem kann Metadaten bestehender PRINT NGEN - Bilder ändern. In PRINT NGEN ändern sich damit nicht die Binärdaten der Bilddatei, sondern lediglich die am Bild gespeicherten Eigenschaften.
...
Include Page | ||||
---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter: