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 |
| Info |
|---|
Hier sind die Logos-Endpunkte der DAM API beschrieben, mit denen Logos im PRINT NGEN DAM angelegt, gesucht, abgerufen und geändert werden können. Der aktuelle Funktionsumfang kann über folgenden Link eingesehen werden: PEIQ DamAPIDAM API |
Funktionalitäten der Logos-Endpunkte der DAM API
Anlegen von Logos
Suche nach Logos
Abrufen der Logo-Bilddateien
Abrufen der Logo-Metainformationen
Ändern der Logo-Metainformationen
...
Bei der Übertragung der Bild-Datei 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.
Die über die DAM API angelegten Logos erhalten den Status “Fertig” und den Bildursprung “DamAPI”.
Beispiel: {baseUrl}/logos?filename=test123.jpg
...
projectId: Mit der projectId="DAMdam" wird unter allen Logos im PRINT 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)
...
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
...
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 PRINT 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 |
...
Ein Drittsystem kann Metadaten bestehender PRINT NGEN - Logos ändern. In NGen PRINT NGEN ändern sich damit nicht die Binärdaten der Bilddatei, sondern lediglich die am Logo gespeicherten Eigenschaften.
...
filename: Dateiname (BildDateiName)
Die Fileextension File-Extension wird herausgefiltert, d. h. in die PRINT NGEN - Eigenschaft BildDateiName “BildDateiName” wird nur der Dateiname ohne Fileextension File-Extension 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)
...
Bei einem Error (z. B. unerlaubte Zeichen) wird keines der übertragenen Metadaten upgedatedaktualisiert.
Logos, die sich gerade in Bearbeitung befinden, können nicht aktualisiert werden.
...
| Include Page | ||||
|---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter: