Mithilfe der PEIQ Cloud-Connect APIs können bestehende Systeme und Produkte mit dem PEIQ Portal verbunden werden. Die Einrichtung der API für das jeweilige Modul ist im Rahmen einer Änderungsanfrage möglich.
Funktionalitäten der API (Cloud-Connect)
Verwendung des OAuth-V2-Standards für die Zugriffskontrolle
Zugriff über Standard HTTPS-Methoden
Inhaltsverzeichnis
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 hier eine interaktive Entwicklerdokumentation. Voraussetzung hierfür 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 Basis URL lautet: https://yourdomain.com/api/v2
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. Die Generation des API Keys ist im Rahmen einer Änderungsanfrage möglich.
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