| Info |
|---|
Mithilfe der PEIQ Cloud-Connect APIs können bestehende Verlage Teile ihrer bestehenden Systeme und Produkte ganz einfach mit dem PEIQ Portal verbunden werden. Die Einrichtung der API für das jeweilige Modul ist im Rahmen einer Änderungsanfrage möglichverbinden. 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
Zugriff über Standard HTTPS-MethodenEinfache Nutzung dank “Try it out”-Funktion
Inhaltsverzeichnis
| Expand | ||||
|---|---|---|---|---|
| ||||
|
...
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 hier eine interaktive Entwicklerdokumentation. Voraussetzung hierfür , 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 “Zugang zur API-Dokumentation”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
...
Als Kommunikationsprotokoll wird HTTPS verwendet. Die Cloud-Connect APIs sind nach der REST-Architektur aufgebaut.
Die Zugriffskontrolle erfolgt hierbei ü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. Die Generation des API Keys ist im Rahmen einer Änderungsanfrage möglich
“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
Verwandte Seiten
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...