Aktionen API

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 wird dabei über die Standard HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.

Mit der Aktionen API können alle Aktionsformen angelegt, editiert und gelöscht werden. Zudem können Sie Aktionen Bild-Assets abrufen und hinzufügen, oder Teilnehmer:innen-Informationen abrufen, hinzufügen und entfernen.

Funktionalitäten der Aktionen API

Aktionsformen angelegen, editieren und löschen
Aktionen Bild-Assets abrufen und hinzufügen
Teilnehmer:innen-Informationen abrufen, hinzufügen und entfernen

Inhaltsverzeichnis

1 Allgemeine Beschreibung
2 Open API Specification
3 Verfügbare Endpunkte
- 3.1 Participation Event
- 3.2 Participation User Entry
4 Verwandte Seiten

Allgemeine Beschreibung

Mit der Aktionen API können externe Systeme die Aktionsformen Verlosung , Umfrage , Frage beantworten , Fotowettbewerb und Texteinsendung anlegen, editieren und löschen, sowie relevante Informationen über diese Aktionen abrufen.

Anlegen, editieren und löschen von Aktionsformen

Alle Aktionsformen des PEIQ PORTALs, inkl. dafür notwendiger Inhalte, Laufzeiten, Pflichtfelder und Bestätigungsfelder, können über die Aktionen-API angelegt, editiert und gelöscht werden.

Informationsabruf angelegter Aktionen

Über die Aktionen-API können die ID und weitere Informationen jeder angelegten Aktion abgerufen werden.

Teilnehmer-Informationen an Aktionsformen aktualisieren

Teilnehmer-Informationen an einer Aktionsform des PEIQ PORTALs können hinzugefügt, gelöscht oder abgerufen werden. Enthält die Aktionsform auch ein Bild-Asset, wird dieses direkt mit der Teilnahme hinzugefügt oder gelöscht.

Open API Specification

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=participation erreichbar.

API-Dokumentation als interaktive Dokumentation

Verfügbare Endpunkte

Participation Event

get /participation/events: Gibt eine paginierte Liste an Aktionsformen nach den gesetzten Filtern aus.
get /participation/events/{event_id}: Gibt eine durch die ID spezifizierte Aktionsform zurück.
POST /participation/events: Erstellt eine neue Aktionsform.
PUT /participation/events/{event_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Aktionsform.
DELETE /participation/events/{event_id}: Löscht die durch die ID spezifizierte Aktionsform unwiderruflich.

Participation User Entry

get /participation/events/{event_id}/userentries: Gibt die Teilnehmerinformationen der durch die ID spezifizierten Aktionsform zurück.
POST /participation/events/{event_id}/userentries: Erstellt eine neue Teilnehmerinformation für eine durch die ID spezifizierte Aktionsform.
DELETE /participation/userentries/{user_entry_id}: Löscht eine durch die ID spezifizierte Teilnehmerinformation.