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 Gogol Cloud-Connect API kann unter /admin/api oder über das Benutzermenü → Administration & Moderation → API 2.0 BETA Dokumentation 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
Einfache Nutzung dank “Try it out”-Funktion

Inhaltsverzeichnis

Inhaltsverzeichnis anzeigen

Allgemeine Beschreibung

Die PEIQ Cloud-Connect API Dokumentation 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. Voraussetzung für den Zugang zur interaktiven Dokumentation ist die Berechtigung “Zugang zur API-Dokumentation”.

Modulübersicht

Die Modulübersicht zeigt auf einen Blick, welche Module im jeweiligen Portal aktiv und damit auch potenziell verfügbar sind. Um eine API benutzen zu können, muss diese für das jeweilige Modul jedoch von PEIQ eingerichtet werden.

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.

“Try it out”-Funktion

Die Dokumentation selbst ist nicht nur rein informativer Natur, sondern bietet darüber hinaus die Möglichkeit, sämtliche API-GET-Endpunkte direkt zu testen. Über diese “Try it out”-Funktion können also Live-Daten aus dem System direkt im JSON-Format exportiert werden. Über die “Try it out”-Funktion können auch noch nicht freigeschaltene APIs unverbindlich getestet werden.

Verfügbare APIs im PEIQ Portal

Location-API
Beitrags-API
Newsletter API
Benutzer API
Routing-API
Veranstaltungskalender-API
Kleinanzeigenmarkt-API
Stellenmarkt API
Federation API Beitrag

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
t.b.a.

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 bzw. vom Kunden Dritten zur Verfügung gestellt 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

API (Cloud-Connect)