Transportverfahren | Übertragung per Restful API (https) |
|---|---|
Objekt | Logos, Datenbanktabelle DLogo |
Trigger | Request durch Drittsystem |
Typische Drittsysteme | Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online |
Beispieldaten | siehe unten |
Hier sind die Logos-Endpunkte der DAM API beschrieben, mit denen Logos im NGEN DAM angelegt, gesucht, abgerufen und geändert werden können.
Der aktuelle Funktionsumfang kann über folgenden Link eingesehen werden: PEIQ DamAPI
Funktionalitäten
Anlegen von Logos
Suche nach Logos
Abrufen der Logo-Bilddateien
Abrufen der Logo-Metainformationen
Ändern der Logo-Metainformationen
Inhaltsverzeichnis
Anlegen von neuen Logos
POST /logos
Ein Drittsystem kann Logos über die DAM API nach PRINT NGEN übertragen. Die Logos werden in der Datenbanktabelle DLogo angelegt.
Bei der Übertragung der Bild-Datei wird die Dateigröße überprüft. Die maximal zulässige Größe einer hochzuladenden Datei ist 104857600 Bytes (100 MB).
Optional kann im URL des Request mit dem Parameter “filename” ein Dateiname mitgegeben werden, der in die NGEN Eigenschaft BildDateiName übernommen wird. Ist beim Dateinamen die Fileextension enthalten, wird diese herausgefiltert.
Die über die DAM API angelegten Logos erhalten den Status “Fertig” und den Bildursprung “DamAPI”
Beispiel: {baseUrl}/logos?filename=test123.jpg
Suche nach bestimmten Logos
GET /logos/search
Von einem Drittsystem aus können per DAM API Logosuchen mit bestimmten Suchbedingungen z. B. bestimmten Kategorien im PEIQ DAM abgesetzt werden. Im Anschluss können die gefundenen Logos bei Bedarf in der gewünschten Auflösung über die DAM API abgeholt werden.
Mögliche Parameter
projectId: Mit der projectId="dam" wird unter allen Logos im NGEN DAM gesucht. Die Angabe der projectId ist obligatorisch.
limit: Anzahl der Logos, die gesucht werden sollen
name: Name des Logos (DLogoName)
filename: Dateinname des Logos (BildDateiName)
categories: Ressort (DLogoRes)
sentFrom: Erstellt ab
sentTo: Erstellt bis
offset oder offsetindex: Gibt an, wie viele Bilder in der Ergebnisliste am Anfang übersprungen werden sollen
Beispiel: {baseUrl}/logos/search?projectId=DAM&limit=50&categories=verein&offset=20211201-11:44:06/261-4018999
Response
Beim Endpunkt GET /logos/search liefern die Ergebnisfelder folgende Inhalte
id: CID
category: Ressort (DLogoRes)
filename: Dateinname (BildDateiName)
width: Breite (BildBreite)
height: Höhe (BildHoehe)
Zudem wird ein Offset mitgeliefert, mit dem im nächsten Request die nächsten Suchergebnisse gefunden werden können.
Abrufen der Logo-Bilddateien
GET /logos/{id}/{resolution}
Die Logos können in folgenden Auflösungen abgerufen werden:
HighRes
MidRes
LowRes
Thumbnail
Beispielhafter Anwendungsfall:
Über die DAM API wurde nach bestimmen Logos gesucht und die IDs der Logos sind nun bekannt. Die Bilddateien der Logos können als nächstes über die ID und Angabe der gewünschten Auflösung abgerufen werden.
Beispiel: {baseUrl}/logos/1-16116144/HighRes
Abrufen der Logo-Metainformationen
GET /logos/{id}
Sind die IDs der Logos bekannt, kann ein Drittsystem folgende Metainformationen über die DAM API abrufen, um diese auch im Drittsystem z.B. für Suchen zur Verfügung zu haben:
Beschreibung | DAM-API Feld | NGen Eigenschaft |
ErstelltAm | creation_timestamp | CED |
ErstelltVon | creation_user | CEB |
Bilddateiname | filename | BildDateiName |
Bildursprung | origin | BildUrsprung |
OriginalID | original_id | COID |
CID | id | CID |
Name | name | DLogoName |
Ressort | category | DLogoRes |
Status | status | Status |
GeändertAm | modification_timestamp | CGD |
GeändertVon | modification_user | CGB |
Kommaseparierte Schlagwörter ohne Prio und Typ | keywords | DLogoSchlagwort |
Bildbreite | width | BildBreite |
Bildhöhe | height | BildHoehe |
SHA1-Wert | sha1 | SHA1 |
Bildausschnitt (wird als relatives Rechteck in 1/10000 Einheiten ausgegeben, d.h. height ist 10000 bei einem Ausschnitt über die volle Höhe des Bildes, width ist 10000 bei einem Ausschnitt über die volle Breite des Bildes) | image_region
| BildAusschnitt |
Beispiel: {baseUrl}/logos/1-16116144
Ändern von Logo-Metainformationen
PUT /logos/{id}
Ein Drittsystem kann Metadaten bestehender NGEN-Logos ändern. In NGen ändern sich damit nicht die Binärdaten der Bilddatei, sondern lediglich die am Logo gespeicherten Eigenschaften.
Folgende Metadaten können geändert werden:
filename: Dateiname (BildDateiName)
Die Fileextension wird herausgefiltert, d.h. in die NGEN-Eigenschaft BildDateiName wird nur der Dateiname ohne Fileextension gesetzt.
Folgende Zeichen sind nicht erlaubt:
*?<>&\/"':
origin: BildUrsprung (BildUrsprung)
category: Ressort (DLogoRes)
Folgende Zeichen sind nicht erlaubt:
*?<>&,%\"'!
name: Name (DLogoName)
keywords: Kommaseparierte Schlagwörter ohne Prio und Typ (DLogoSchlagwort)
Felder, die nicht angegeben werden, werden nicht verändert.
Bei einem Error (z.B. unerlaubte Zeichen) wird keines der übertragenen Metadaten upgedated.
Logos, die sich gerade in Bearbeitung befinden, können nicht aktualisiert werden.
Verwandte Seiten
Disclaimer
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ GmbH erlaubt. 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 PEIQ 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.
Nur für PEIQ-Mitarbeiter: