[0-21] DAM-API - Logos

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, 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 Bilder können in folgenden Auflösungen abgerufen werden:

• HighRes

• MidRes

• LowRes

• Thumbnail

Beispielhafter Anwendungsfall:

Über die DAM-API wurde nach bestimmen Bilden gesucht und die IDs der Bilder sind nun bekannt. Die Bilddateien 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:

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)

• image_region: Bildausschnitt (BildAusschnitt)

  • height: Höhe des Ausschnitts (keine negativen Werte erlaubt)

  • width: Breite des Ausschnitts (keine negativen Werte erlaubt)

  • position_x: X-Koordinate des Eckpunktes des Ausschnitts oben links (keine negativen Werte erlaubt)

  • position_y: Y-Koordinate des Eckpunktes des Ausschnitts oben links (keine negativen Werte erlaubt)

  • Einheit für die Ausschnittsinformationen: 1/10000 zur Gesamthöhe/-breite des Bildes, 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

  • Um einen Ausschnitt zu entfernen, wird "image_region": NULL übergeben

Felder, die nicht angegeben werden, werden nicht verändert.

Bei einem Error (z.B. unerlaubte Zeichen) wird keines der übertragenen Metadaten upgedated.

Der Bildausschnitt kann im Status “Fertig” nicht verändert werden.

Logos, die sich gerade in Bearbeitung befinden, können nicht aktualisiert werden.

Verwandte Seiten

• Page:
  PEIQ Ad API
• Page:
  [2-4] INBOUND OUTBOUND CREATE API
• Page:
  [0-21] DAM API - Embeds
• Page:
  [0-21] DAM API - Logos
• Page:
  [0-21] DAM API - Images
• Page:
  Empfehlung Workflow PayPal-Bezahlung über externes CRM über die Ad API an den PEIQ Werbemarkt bis zum nachgelagerten Finance-System
• Page:
  Empfehlung Workflow Anbindung eines externen CRM über die Ad API an den PEIQ Werbemarkt
• Page:
  Empfehlung Workflow Anbindung einer externen Anzeigenproduktion über die Ad API an den PEIQ Werbemarkt

^{Nur für PEIQ-Mitarbeiter:}

/wiki/spaces/CORE/pages/915931174