PEIQ Knowledge Base
[0-24] PEIQ PRINT API
Transportverfahren | Übertragung per Restful API (https) |
---|---|
Objekt | PRINT NGEN Artikel und Seiten |
Trigger | Request durch Drittsystem |
Typische Drittsysteme | Typische Anbindungen sind Drittsysteme zur Content-Erstellung für Online |
Beispieldaten | siehe unten |
Mit den hier beschriebenen Funktionen können Artikel abgefragt, angelegt und aktualisiert sowie Bilder durch Dritte via Restful API gesucht (Ergebnisliste mit Metadaten und Preview-Link) und in verschiedenen Auflösungen von PRINT NGEN in das Drittsystem exportiert werden.
Die Bereitstellung der Zugangsdaten zur Authentifizierung erfolgt durch PEIQ. Zudem sind Mitwirkungspflichten zur Aktivierung der API notwendig. Bei Interesse wenden Sie sich daher bitte an das PEIQ Support Team.
Funktionalitäten der PRINT API
Anlegen von Artikeln
Updaten von Artikeln
Abrufen der Metadaten von Artikeln
Suche nach bestimmten Artikeln
Preview von Artikeln
Abrufen der Metadaten von Seiten
Preview von Seiten
Abrufen der API Informationen
Inhaltsverzeichnis
Allgemeine Beschreibung
Funktionalitäten der PRINT API
Mit den hier beschriebenen Funktionen können Printartikel aus dem PEIQ DAM durch Dritte via Restful API abgefragt, in PRINT NGEN angelegt, geändert und vom PEIQ DAM in das Drittsystem exportiert werden.
Typische Anbindung sind Drittsysteme zur Content-Erstellung für Online.
Die DAM API korrespondiert dazu. Die in der PRINT API referenzierten Bilder sind entsprechend über die DAM API abrufbar.
Der aktuelle Funktionsumfang kann über folgenden Link eingesehen werden: https://mt-master-create.peiq.cloud/printapi/ui/index.html
Articles
Die Endpunkte für Artikel sind auf folgender Seite beschrieben: [0-21] DAM API - Images
Pages
Die Endpunkte für Seiten sind auf folgender Seite beschrieben: [0-21] DAM API - Logos
Infos
Abrufen der API-Informationen: GET /info
Über diesen Endpunkt kann die Version der PRINT API sowie der API User abgefragt werden.
Vergleich PRINT API vs. Livingdocs API
PRINT API | Livingdocs API |
POST /articles/json identisch wie Livingdocs API | GET v1/print/document identisch wie PRINT API |
GET /articles/search Hier werden die neusten Artikel in PRINT NGEN zurückgeliefert. Zudem stehen weitere Filtermöglichkeiten zur Verfügung. | GET api/v1/publicationEvents Hier werden die neusten, publizierten Artikel in Livingdocs zurückgeliefert. |
GET /articles/{id} | nicht vorhanden |
GET /articles/search | nicht vorhanden |
GET /articles/preview/{id}/{resolution}/{page_id} | nicht vorhanden |
GET /articles/preview/json/{resolution} | nicht vorhanden |
GET /pages/{id} | nicht vorhanden |
GET /pages/preview/{id}/{resolution} | nicht vorhanden |
Verwandte Seiten
Nur für PEIQ-Mitarbeiter:
https://peiq.atlassian.net/wiki/x/cACZY