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. |
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.
Pixeldaten
IPTC-Daten (geänderte Metadaten optional)
Bildunterschrift (optional)
Ort/Stadt (optional)
Kategorien (optional)
--
Tests
Zur Authentifizierung muss im Header der im folgenden beschriebenen Aufrufe ein Token mitgegeben werden. Dieser wird durch PEIQ festgelegt und bei der Einrichtung mitgeteilt.
Ü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.
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) |
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 |
Ü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.
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 eines/r bestimmten Dienstes/Agentur, 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) |
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 | Beschreibung des Bildes |
category | Kategorie/Ressort des Bildes |
credit | Copyright des Bildes |
location | Ort/Stadt des Bildes |
width | Breite des Bildes (in Pixel) |
height | Höhe des Bildes (in Pixel) |
Ü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.
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) |
|
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.
DBild
/wiki/spaces/CORE/pages/915931174