API (Cloud-Connect)

Mithilfe der PEIQ Cloud-Connect APIs (engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff erfolgt dadurch mit den Standard HTTP-Methoden GET, POST, PUT und DELETE. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.

Die Dokumentation der Cloud-Connect API kann von berechtigten Nutzern über die Administration & Moderation oder unter /admin/api aufgerufen werden. Hier steht eine interaktive Entwicklerdokumentation zur Verfügung.

Funktionalitäten der API (Cloud-Connect)

Anbindung bestehenden Systeme und Produkte
Interaktive Entwicklerdokumentation mit potentiellen Anwendungsmöglichkeiten der verfügbaren APIs
Verwendung des OAuth-V2-Standards für die Zugriffskontrolle

Inhaltsverzeichnis

Inhaltsverzeichnis anzeigen

Dokumentation zur PEIQ Cloud-Connect API

Die Dokumentation zur PEIQ Cloud-Connect API kann im PORTAL über die “Administration & Moderation” erreicht werden. Unter dem Menüpunkt “API 2.0 BETA Dokumentation” findet sich eine interaktive Entwicklerdokumentation, die eine Übersicht der potentiellen Anwendungsmöglichkeiten der diversen APIs im PEIQ PORTAL bietet. Näheres hierzu siehe API 2.0 Dokumentation.

Verfügbare APIs im PEIQ PORTAL

Grundsätzlich stehen all diejenigen APIs zur Verfügung, deren zugehöriges Modul im jeweiligen PORTAL aktiv ist. Einen Überblick, welche Module im PORTAL aktiv und damit auch welche APIs potenziell verfügbar sind, bietet die Modulübersicht. Diese steht unter API 2.0 BETA Dokumentation in der Administration & Moderation zur Verfügung. Näheres siehe API 2.0 Dokumentation.

Requests und Autorisierung

Die Zugriffskontrolle erfolgt über eine Implementierung nach OAuth-V2-Standard. Um Zugriff auf die API zu erhalten, ist ein API Key notwendig, der von PEIQ generiert werden muss.

Formular: Editieren/ Deaktiveren/ Hinzufügen des API-Zugangs

Übergabe API-Zugang

[Name des Zugangs]
client id:
client secret:
aktive API	Lesend	Schreibend
Beitrags-API
Location-API
User-API
Newsletter-API
Veranstaltungskalender-API
Stellenmarkt-API
Kleinanzeigen-API
Routing-API
Federation-API Beitrag

Legende: “1” = aktiv, “0” = inaktiv, “-” = nicht vorhanden

1. Editieren/ Deaktiveren/ Hinzufügen des API-Zugangs

Um einen API-Zugang zu Editieren/ Deaktivieren oder Hinzuzufügen, kann ein Ticket im PEIQ Service Desk, unter Nennung des API-Zugang Namens, eingestellt werden. Das Löschen oder Anpassen kann dann nach Aufwand erfolgen.

2. Wichtige Hinweise:

Der API-Zugang kann Livedaten beeinflussen und sollte entsprechend sorgsam eingesetzt werden.
Wird Dritten der API-Zugang vom Kunden zur Verfügung gestellt, wird empfohlen, dass der Kunde eigenständig mit diesen Dritten einen ADV-Vertrag (Vertrag zur Auftragsdatenverarbeitung) abschließt.
Über die User-API können nutzerbezogene Daten bezogen oder verändert werden.

3. Zugang zur API-Dokumentation

Benutzer der Onlineplattform, mit entsprechender Berechtigung, erhalten Zugang zur API-Dokumentation.
Für externe Benutzer kann in der oben beschriebenen, systeminternen Dokumentation die API-Spezifikationsdatei heruntergeladen werden.

Basis URL

https://yourdomain.com/api/v2/

Alle API Requests müsse über HTTPS gesendet werden. Requests über HTTP schlagen fehl. API Requests ohne Authorisierung werden ebenfalls fehlschlagen.

Findet die Konnektierung der API über eine htaccess-geschützte Staging-Umgebung statt, muss eine IP-Freigabe (oder Netzwerkfreigabe, z.B. falls mehrere Entwickler aus dem gleichen Netzwerk zugreifen wollen) erfolgen. Dazu bitte an das PEIQ Support Team wenden.

FAQs

Zu Bilder-Workflows über die APIs:

Ist für das Abholen von Bildern über eine Dritt-API eine Authentifizierung (z.B. Basic-Authentification) vorgesehen?

Eine HTTP Basic Authentication kann über die URL mitgegeben werden (z.B. https://user:pass@domain.tld/path ). Andere Formen der Authentifizierung beim Download der Bilder sind nicht vorgesehen.

Was sollte die maximale Auflösung der zu importierenden Bilder sein?

Das ist abhängig vom Use-Case: Sofern die Bilder aus dem PORTAL zu einem PRINT-System exportiert und dort weiterverwendet werden sollen (z. B. im PEIQ PRINT PPS), sollten sie entsprechend größer angeliefert werden. Ansonsten genügen kleinere Bildgrößen. Als Referenz: Die größte im PORTAL generierte Variante hat 2048px.

Kann beim Update eines Image mit "PUT" tatsächlich keine "url" angegeben werden?

Bilder (Image Objekte) werden im PORTAL beim Erstellen fest mit einer Bilddatei verknüpft, es ist nicht möglich das Objekt beizubehalten und die Datei auszutauschen. Dementsprechend sind Bild-Updates im Sinne einer aktualisierten Bilddatei nur möglich, indem das Bild gelöscht (DELETE) und das neue Bild importiert (POST) wird.