PEIQ Knowledge Base
Mitwirkungspflichten: [0-17] INBOUND Livingdocs API | Artikel mit Bilder
Die Dokumentation zu dieser Schnittstelle befindet sich hier:
1. Zugangsdaten Livingdocs-Kundensystem
Beschreibung
Bitte übermitteln Sie uns Zugangsdaten zu Ihrem Livingdocs System sowie dem Testsystem. Nutzen Sie für den Zugang folgenden Account: projektmanagement@peiq.de
Zudem wird der Token sowie die Adressen für den API Abruf von Produktiv- und Testsystem benötigt.
Achtung: Ohne den Zugang kann die Einrichtung der Schnittstelle nicht begonnen werden.
Mitwirkung
Übermittlung des Zugangs (Test + Produktivsystem) sowie des Tokens und der Adressen für den API Abruf (Test + Produktivsystem)
2. Server-Informationen
Bitte teilen Sie uns mit, über welche URLs die API erreichbar ist, z.B.:
Production: https://api.beispiel-verlag.de mit Abruf der Events unter: https://api.beispiel-verlag.de/api/v1/publicationEvents
Staging: https://server-staging.beispiel-verlag.dev mit Abruf der Events unter: https://server-staging.beispiel-verlag.dev/api/v1/publicationEvents
Development: https://server.beispiel-verlag.dev mit Abruf der Events unter: https://server.beispiel-verlag.dev/api/v1/publicationEventsTeilen Sie uns zudem bitte die Objekte mit, für die Artikel über die API abgerufen werden sollen, z.B.:
objekt1 mit Aufruf der Artikel unter https://api.beispiel-verlag.de/objekt1/v1/print/documentZudem wird zum Autorisieren ein Token mitgegeben. Teilen Sie uns bitte auch diesen mit.
Mitwirkung
Übermittlung, über welche URLs die API erreichbar ist sowie die Objekte und den Token.
3. Mapping-Abbildungen
Das auf der Seite https://peiq.atlassian.net/wiki/spaces/PPSD/pages/1277329409 genannte Customizing für das Mapping von Objekt, Ausgabe und Ressort muss durch die bzw. den Cloud-Kund:in initial beim Setup selbstständig eingerichtet und gepflegt werden.
Sollten neue Objekte, Ausgaben oder Ressorts hinzukommen oder sich die Bezeichnungen ändern, sind diese Änderungen durch die bzw. den Cloud Kund:in selbstständig anzupassen.
Mitwirkung
Einrichtung und Pflege der aufgeführten Mapping-Abbildungen.
Testing
Es sind eigenständige kundenseitige Tests in den dafür vorbereiteten Umgebungen durchzuführen. Insbesondere ist zu testen, dass die Livingdocs Artikel auffindbar und die Werte für Objekt, Ausgabe und Ressort korrekt zugewiesen sind.
Anpassung im Betrieb
Sollten Sie weitere Ressorts ergänzen wollen, bitten wir Sie, dafür ein Ticket mit Angabe der gewünschten Änderungen aufzugeben.