Mithilfe der PEIQ Cloud-Connect APIs können bestehende Systeme und Produkte mit dem PEIQ Portal verbunden werden. 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.
Funktionalitäten der API (Cloud-Connect)
Verwendung des OAuth V2 Standards für die Zugriffskontrolle
Zugriff über Standard HTTP-Methoden
Verwendung des API keys
Inhaltsverzeichnis
Die Basis URL und Requests
Die Basis URL lautet: https://yourdomain.com/api/v2
Als Kommunikationsprotokoll wird HTTPS verwendet. Dementsprechend schlagen Requests über HTTP fehl.
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
Autorisierung
Um Zugriff auf die API zu erhalten, ist ein API Key notwendig. Dieser besteht aus einer Client-ID und einem Client-Secret. Die Authentifizierung ist auch für die “Try it out Funktion” erforderlich.
Die Generation eines API Keys ist im Rahmen einer Änderungsanfrage releaseunabhängig möglich.
Die Autorisierung