IN BEARBEITUNG
Transportverfahren | Übertragung per Restful API (https) |
---|---|
Objekt | Bilder, 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 |
Mit der hier beschriebenen Exportfunktion können Bilder durch Dritte via Restful API gesucht werden (Ergebnisliste mit Metadaten und Preview-Link) und Bilder in verschiedenen Auflösungen von NGen in das Drittsystem exportiert werden.
Inhaltsverzeichnis
Funktionalitäten der DAM-API
Mit der hier beschriebenen Exportfunktion können Bilder durch Dritte via Restful API gesucht werden (Ergebnisliste mit Metadaten und Preview-Link) und Bilder in verschiedenen Auflösungen von NGen in das Drittsystem exportiert werden.
Typische Anbindung sind Drittsysteme zur Content-Erstellung für Online.
Austauschformat und Übertragung der Daten
Metadaten der Bild-Daten, die übertragen werden können
Pixeldaten
IPTC-Daten (geänderte Metadaten optional)
Bildunterschrift (optional)
Ort (optional)
Kategorien (optional)
Ausbaustufen
--
Mitwirkungspflichten/Beistellung des Kunden
Tests
Aufbereitung und Übertragung der Daten
Weiterführender Link: https://testweb.impuls.peiq.cloud/apis/damapi.html#/
GET /images/latest (Abfrage der neu erstellten Bilder)
Über den Endpunkt GET /images/latest können Drittsysteme die neu erstellten Bilder seit einem bestimmten Offset abfragen. Wird kein Offset mitgegeben, werden die IDs der ersten Bilder zurückgeliefert. Jede Abfrage liefert einen Offset zurück, der bei der nächsten Abfrage mitgegeben werden muss.
Parameter, die bei der Abfrage mitgegeben werden können
projectId (string) (erforderlich) |
|
---|---|
offset (string) (beim ersten Aufruf optional, dann erforderlich) | Offset des Erstellungsdatums der Bilder für den Aufruf |
limit (integer) (optional) | Max. Anzahl der Bilder, die abgefragt werden sollen (default: 100, maximal: 1000) |
Responses
200 | OK |
400 | Bad Request |
401 | Access Token fehlt oder nicht richtig |
404 | Es wurden für die Abfrage keine Bilder gefunden |
War der Aufruf OK, werden die Bild-IDs nach folgendem Schema als JSON zurückgeliefert:
{ "offset": "string", "ids": [ "a1ynb0#x", "9z#uexb8" ] }
offset | Neuer Offset des Erstellungsdatums der Bilder |
---|---|
ids | Bild-IDs, die die Abfrage zurückliefert |
GET /images/search (Suche nach Bildern)
Über den Endpunkt GET /images/search können Drittsysteme Suchen nach Bildern im NGen DAM absetzen. Die Suche kann über beliebig viele Parameter eingeschränkt werden. Zurückgeliefert werden die Bilder in der Reihenfolge ihres Erstellungsdatums.
Parameter, die bei der Abfrage mitgegeben werden können
projectId (string) (erforderlich) |
|
---|---|
search (string) (optional) | Volltextsuche (ohne Berücksichtigung der Groß-/Kleinschreibung), Suche liefert die Bilder zurück, die alle angegebenen Wörter enthält (z.B. Suche nach “angela merkel” liefert die Bilder zurück die “angela” und “merkel” enthalten) |
categories (array (string)) (optional) | Suche nach Bildern mit bestimmten Kategorien/Ressorts, die gesuchten Kategorien/Ressorts sind mit “OR” verbunden, d.h. es werden die Bilder zurückgeliefert, die mindestens einer der Kategorien entsprechen |
services (array (string)) (optional) | Suche nach Bildern mit bestimmten Services, die gesuchten Services sind mit “OR” verbunden, d.h. es werden die Bilder zurückgeliefert, die mindestens einer der Services entsprechen |
credit (string) (optional) | Suche nach Bildern mit bestimmtem Copyright |
sentFrom (string ($date-time)) (optional) | Suche nach Bildern, die ab einem bestimmten Zeitpunkt erstellt wurden, z.B. “2021-01-20T09:15:28Z” |
sentFrom (string ($date-time)) (optional) | Suche nach Bildern, die bis zu einem bestimmten Zeitpunkt erstellt wurden, z.B. “2022-01-20T09:15:28Z” |
offset (string) (optional) | Suche in bestimmtem Offset des Erstellungsdatums der Bilder |
limit (integer) (optional) | Max. Anzahl der Bilder, die abgefragt werden sollen (default: 100, maximal: 1000) |
Responses
200 | OK |
---|---|
400 | Bad Request |
401 | Access Token fehlt oder nicht richtig |
404 | Es wurden für die Abfrage keine Bilder gefunden |
War der Aufruf OK, werden die Bild-IDs nach folgendem Schema als JSON zurückgeliefert:
{ "offset": "string", "data": [ { "id": "string", "caption": "string", "category": "string", "credit": "string", "location": "string", "width": 0, "height": 0 } ] }
offset | Neuer Offset des Erstellungsdatums der Bilder |
---|---|
id | Bild-ID, die die Abfrage zurückliefert |
caption | Bildunterschrift des Bildes |
category | Kategorie/Ressort des Bildes |
credit | Copyright des Bildes |
location | Ort des Bildes |
width | Breite des Bildes (in Pixel) |
height | Höhe des Bildes (in Pixel) |
GET /images/[id]/[resolution]
Über den Endpunkt GET /images/[id]/[resolution] können Drittsysteme einzelne Bild-Dateien aus dem NGen DAM abrufen. Die HighRes-Auflösung kann bei allen Bild-Typen abgefragt werden, alle anderen Auflösungen nur bei JPG und PNG.
Parameter, die bei der Abfrage mitgegeben werden können
id (string) (erforderlich) | Bild-ID, die über den Endpunkt GET /images/latest oder GET /images/search zurückgeliefert wurde |
---|---|
resolution (string) (erforderlich) | Auflösung, die abgerufen werden soll: Thumbnail, LowRes, MidRes, HighRes |
updateMetadata (boolean) (optional) |
|
Responses
200 | OK |
---|---|
400 | Bad Request |
401 | Access Token fehlt oder nicht richtig |
404 | Das Bild wurde nicht gefunden |
War der Aufruf OK, werden die Bilder als string zurückgeliefert.
Maßgebliche DB-Tabellen
DBild
Rechtlicher Hinweis
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) nur mit schriftlicher Genehmigung der multicom GmbH. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern.
Die vorliegenden Angaben dienen lediglich Informationszwecken. Die multicom GmbH übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben.
Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.
Versionierung
Verwandte Seiten
Optionale, weitergehende Infos (auf Anfrage)
/wiki/spaces/CORE/pages/915931174
Historie
Version | Date | Comment |
---|---|---|
Current Version (v. 4) | 2022-01-31 12:24 | Violetta Stegen |
v. 32 | 2023-05-09 09:21 | Johanna Cüsters |
v. 31 | 2023-05-09 09:10 | Johanna Cüsters |
v. 30 | 2023-04-05 08:10 | Daniela Nguyen |
v. 29 | 2023-04-03 14:37 | Daniela Nguyen |
v. 28 | 2022-11-25 10:20 | Daniela Nguyen |
v. 27 | 2022-08-22 09:39 | Alexander Steichele |
v. 26 | 2022-08-05 12:26 | Former user |
v. 25 | 2022-08-04 06:31 | Violetta Stegen |
v. 24 | 2022-07-27 10:54 | Violetta Stegen |
v. 23 | 2022-07-20 09:25 | Violetta Stegen |
v. 22 | 2022-06-21 08:31 | Daniela Nguyen |
v. 21 | 2022-06-21 06:16 | Violetta Stegen |
v. 20 | 2022-06-17 14:27 | Daniela Nguyen |
v. 19 | 2022-06-15 12:59 | Former user |
v. 18 | 2022-06-10 14:01 | Daniela Nguyen |
v. 17 | 2022-06-10 14:00 | Daniela Nguyen |
v. 16 | 2022-05-17 09:49 | Daniela Nguyen |
v. 15 | 2022-04-20 11:42 | Former user |
v. 14 | 2022-02-21 10:55 | Violetta Stegen |
v. 13 | 2022-02-21 10:54 | Violetta Stegen |
v. 12 | 2022-02-15 09:35 | Violetta Stegen |
v. 11 | 2022-02-15 09:30 | Violetta Stegen |
v. 10 | 2022-02-14 12:53 | Violetta Stegen |
v. 9 | 2022-02-11 14:45 | Manh Long Nguyen |
v. 8 | 2022-02-03 10:46 | Violetta Stegen |
v. 7 | 2022-02-02 12:25 | Violetta Stegen |
v. 6 | 2022-02-02 10:06 | Violetta Stegen |
v. 5 | 2022-02-01 11:12 | Violetta Stegen |
v. 4 | 2022-01-31 12:24 | Violetta Stegen |
v. 3 | 2022-01-31 12:08 | Violetta Stegen |
v. 2 | 2022-01-31 12:07 | Violetta Stegen |
v. 1 | 2021-11-03 14:25 | Katharina Marxreiter |