Status | ||||
---|---|---|---|---|
|
Zusammenfassung
Webservice
REST
Objekt
JSON
Trigger
Info |
---|
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 |
Anbieter
PEIQ
Syntax
Eventcalendar-API
Info |
---|
und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard. Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert. |
Produkt (Label)
Portal
Übergeordnetes Modul (Label)
Funktionalitäten der Veranstaltungskalender API
Auslesen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Anlegen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Ändern der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Löschen der im PORTAL vorliegenden Veranstaltungen, Bilder und Kommentare
Inhaltsverzeichnis
Expand | ||||
---|---|---|---|---|
| ||||
|
Allgemeine Beschreibung
Basis URLCode Block | ||
---|---|---|
| ||
https://yourdomain.com/api/v2/eventitems |
Die
API
-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=eventcalendar
erreichbar.
Das swagger-File kann auch hier heruntergeladen werden (Stand: ):
View file | ||
---|---|---|
|
Verfügbare Endpunkte
Eventitem
Veranstaltungen werden vom System als Eventitems
bezeichnet. Ein Eventitem
enthält verschiedene Parameter zur Festlegung des Ortes und des Zeitpunkts der Veranstaltungder Orte und der Zeitpunkte der Veranstaltung. Es sind mehrere Veranstaltungsorte sowie mehrere Zeitpunkte der Veranstaltungen (=Termine) pro Eventitem
möglich.
Status colour Blue title
Get All Eventitems by Filters
status (Available values: draft, published, rejected, scheduled, deleted)
date_filter_type (Available values: published, created, updated ; Default value: published)
date_start
date_end
location_ids
user_id
user_segment
category_id
statig_tags (Available value: commercial)
Get Eventitem by Id
eventitem_id
Response
language | json |
---|
/eventitems: Gibt eine paginierte Liste an Veranstaltungen nach den gesetzten Filtern aus.GET
/eventitems/{eventitem_id}: Gibt die durch die ID spezifizierte Veranstaltung zurück.Status colour Blue title GET Status colour Green title
/eventitems: Erstellt eine neue Veranstaltung.POST Status colour Yellow title PUT
Update Eventitem by Id
/eventitems/{eventitem_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Veranstaltung.
Status colour Red title
Delete Eventitem by Id
/eventitems/{eventitem_idDELETE
Request Body
Code Block | ||
---|---|---|
| ||
{
"poi_data": {
"id": "1",
"name": "Rathaus",
"street": "Maximilianstraße",
"city": "Augsburg",
"zipcode": "86150",
"lat": "41.4123541",
"lng": "10.213123412",
"url": "https://goo.gl/maps/9sEHVqx6jSA2"
},
"status": "draft",
"created": "2019-03-07T00:00:00+00:00",
"published": "2019-03-07T00:00:00+00:00",
"title": "Test Event #1",
"description": "This is the description of Test Event #1",
"eventitem_dates": [
"2019-03-30T18:30:00",
"2019-04-31T12:30:00"
],
"static_tags": [
"commercial"
],
"user_id": 1,
"category_id": 1,
"location_id": 17,
"tags": [
"Tagger",
"I'm a Tag"
]
} |
HTTP Status Codes
Code Block | ||
---|---|---|
| ||
200 - Success Alles hat wie erwartet funktioniert
201 - Eventitem Successfully created / deleted
204 - Eventitem Successfully updated
400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren |
Verfügbare Endpunkte für Eventitem Categories
Dieser Endpunkt bildet einen speziellen Endpunkt zum einfacheren Auslesen der Veranstaltungs-Kategorien.
}: Löscht die durch die ID spezifizierte Veranstaltung unwiderruflich.
Note |
---|
Das PORTAL prüft bei der Beitrags API sowie bei der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 nicht dahingehend, ob die gesendete |
Eventitem Category
HTTP Status Codes
Code Block |
---|
200 - Success Alles hat wie erwartet funktioniert
400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren |
Verfügbare Endpunkte für Eventitem Comments
Dieser Endpunkt bildet einen speziellen Endpunkt für /wiki/spaces/CORE/pages/50889901 an Veranstaltungen.
language | text |
---|
/eventitems/categories: Gibt eine Liste der im PORTAL hinterlegten Kategorien für Veranstaltungen zurück (Informationen:Status colour Blue title GET id
,name
,name_norm
).Status colour Blue title
Get All Eventitem Categories
Get Eventitem Category by Id
category_id
Response
Code Block | ||
---|---|---|
| ||
[
{
"id": "1",
"name": "Sport",
"name_norm": "sport"
}
] |
/eventitems/categories/{category_id}: Gibt die durch die ID spezifizierten Kategorie für Veranstaltungen zurück (Informationen:GET id
,name
,name_norm
).
Eventitem Comment
/eventitems/{eventitem_id}/commentsStatus colour Blue title GET
Status | ||||
---|---|---|---|---|
|
Get Eventitem Comments
eventitem_id
Response
language | json |
---|
: Gibt die Kommentare der durch die ID spezifizierten Veranstaltung zurück.
Status colour Green title
Create Eventitem Comment
/eventitems/{eventitem_id}/comments: Erstellt einen Kommentar an der durch die ID spezifizierten Veranstaltung.POST Status colour Yellow title
Update Eventitem Comment
HTTP Status Codes
Code Block |
---|
200 - Success Alles hat wie erwartet funktioniert
201 - Eventitem Comment Successfully created / deleted
204 - Eventitem Comment Successfully updated
400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Not Found Die Veranstaltung/Der Kommentar mit der angegebenen ID scheint nicht zu existieren |
Verfügbare Endpunkte für Eventitem Images
Dieser Endpunkt bildet einen speziellen Endpunkt für Bilder von Veranstaltungen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zum Urheber.
language | text |
---|
/eventitems/comments/{comment_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Kommentars.PUT Status colour Red title
Delete Eventitem Comment
comment_id
Request Body
Code Block | ||
---|---|---|
| ||
[
{
"author_id": 1,
"text": "This is a test comment!",
"created": "2019-03-07T00:00:00+00:00"
}
] |
/eventitems/comments/{comment_id}: Löscht den durch die ID spezifizierten Kommentar.DELETE
Eventitem Image
/eventitems/{eventitem_id}/images: Gibt alle Bilder der durch die ID spezifizierten Veranstaltung zurück.Status colour Blue title GET Status colour Blue title
Get all Images for a specific Eventitem
eventitem_id
Get Eventitem Image by image_id
image_id
Response
language | json |
---|
/eventitems/images/{image_id}: Gibt das durch die ID spezifizierte Bild einer Veranstaltung zurück.GET Status colour Green title
Upload Images for a specific Eventitem
/eventitems/{eventitem_id}/images: Fügt ein oder mehrere Bilder (POST array
) einer durch die ID spezifizierten Veranstaltung hinzu.Status colour Yellow title
Update Eventitem Image by image_id
image_id
/eventitems/images/{image_id}: Aktualisiert die Meta-Informationen (hochgeladen von, Copyright, Bildunterschrift, Bildfokus) des durch die ID spezifizierten Bildes.PUT Status colour Red title
Delete Eventitem Image by image_id
image_id
Request Body
Code Block | ||
---|---|---|
| ||
[
{
"url": "https://www.example.com/resources/mediadb/event/2019/03/04/1/1_XL.jpg",
"user_id": 1,
"creation_date": "2019-03-07T00:00:00+00:00",
"caption": "Test Image Caption",
"copyright": "Test Image Copyright",
"focus_x": "2",
"focus_y": "3"
}
] |
HTTP Status Codes
Code Block | ||
---|---|---|
| ||
200 - Success Alles hat wie erwartet funktioniert
201 - Eventitem Image Successfully uploaded / deleted
204 - Eventitem Image Successfully updated
400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Not Found Die Veranstaltung/Das Bild mit der angegebenen ID scheint nicht zu existieren |
Setup & Konfiguration
Aktivierung Feature
Aufwand Technik
Als Change Request (Releaseunabhängig)
0,25PH
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”
Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.
Konfigurationsparameter
Warning |
---|
Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden. |
Bekannte Einschränkungen
Note |
---|
|
Entwicklungsverlauf
Links zu Issues, Tickets, etc. Neueste zuerst:
Modul im Einsatz bei
Alte Version (V1) genutzt von:
[KIRCHENZTG] (meine-kirchenzeitung.de)
Status | ||||
---|---|---|---|---|
|
/eventitems/images/{image_id}: Löscht das durch die ID spezifizierte Bild einer Veranstaltung unwiderruflich.DELETE
Note |
---|
Bilder werden asynchron importiert. |
Note |
---|
Bilder müssen für einen Import in das PORTAL von einer öffentlich zugänglichen URL abrufbar sein. Die Bilder können nicht direkt in das PORTAL eingespeist werden. Dies ist eine Maßnahme zur besseren Skalierbarkeit, um das System, bzw. die Schnittstelle nicht zu überlasten und eine schnelle Verarbeitung der Importe zu gewährleisten. |
Verwandte Themen
Verwandte Seiten
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
Verwandte Labels
Related Labels | ||
---|---|---|
|
Ansprechpartner
Teil 2 - EXTERN für Kunden & InteressentenNote | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Bei den
|
|
|
Note |
---|
In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert. Neue Auszüge können über Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087. |
image -Endpunkten nicht genutzt werden.Stattdessen kann die
|
|
Note |
---|
Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das? |
Details
Status | ||||
---|---|---|---|---|
|
Note |
---|
Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung). |
Vorläufig übertragen aus Extern (Externe Seite gelöscht)
Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert.
Bei der Veranstaltungs-API handelt es sich um ein Feature, welches releaseunabhängig im Rahmen einer Änderungsanfrage aktiviert werden kann.
Die API 2.0 Dokumentation dagegen ist auch ohne Aktivierung vorhanden.
Funktionalitäten der Veranstaltungskalender-API
Diverse Endpunkte für den Veranstaltungskalender
Trigger: GET, PUT, POST, DELETE
Die Basis URL
Code Block |
---|
https://yourdomain.com/api/v2/eventitems |
Die Veranstaltungskalender API ist der API Endpunkt für Veranstaltungen . Über die unten genannten Endpunkte können die im Portal vorliegenden Veranstaltungen, ihre Bilder und Kommentare ausgelesen, angelegt, geändert oder gelöscht werden.
Verfügbare Endpunkte für Eventitems (Veranstaltung)
Veranstaltungen werden vom System als Eventitems bezeichnet. Ein Eventitem enthält verschiedene Parameter zur Festlegung des Ortes und des Zeitpunkts der Veranstaltung.
GET
Get All Eventitems by Filters
status (Available values: draft, published, rejected, scheduled, deleted)
date_filter_type (Available values: published, created, updated ; Default value: published)
date_start
date_end
location_ids
user_id
user_segment
category_id
statig_tags (Available value: commercial)
Get Eventitem by Id
eventitem_id
POST
Create Eventitem
PUT
Update Eventitem by Id
eventitem_id
DELETE
Delete Eventitem by Id
eventitem_id
Response Body
Code Block |
---|
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"url": "https://www.example.com/event/augsburg/c-category-a/test-event-1_e1",
"poi_data": {
"id": "1",
"name": "Rathaus",
"street": "Maximilianstraße",
"city": "Augsburg",
"zipcode": "86150",
"lat": "41.4123541",
"lng": "10.213123412",
"url": "https://goo.gl/maps/9sEHVqx6jSA2"
},
"status": "draft",
"created": "2019-03-07T00:00:00+00:00",
"published": "2019-03-07T00:00:00+00:00",
"updated": "2019-03-07T00:00:00+00:00",
"title": "Test Event #1",
"description": "This is the description of Test Event #1",
"eventitem_dates": [
"2019-03-30T18:30:00",
"2019-04-31T12:30:00"
],
"static_tags": [
"commercial"
],
"user_id": 1,
"category_id": 1,
"location_id": 17,
"thumbnail": {
"url": "https://www.example.com/resources/mediadb/event/2019/03/04/1/1_XL.jpg",
"remote_id": "1234",
"id": "12"
},
"image_count": "5",
"visit_count": "1235",
"like_count": "15",
"tags": [
"Tagger",
"I'm a Tag"
]
}
]
} |
Der Response-Body - Struktur einer Veranstaltung
HTTP Status Codes
Code Block |
---|
200 - Success Alles hat wie erwartet funktioniert
201 - Eventitem Successfully created / deleted
204 - Eventitem Successfully updated
400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren |
HTTP Status Codes
Verfügbare Endpunkte für Eventitem Categories
Dieser Endpunkt bildet einen speziellen Endpunkt zum einfacheren Auslesen der Veranstaltungs-Kategorien.
Code Block |
---|
https://yourdomain.com/api/v2/eventitems/categories |
GET
Get All Eventitem Categories
Get Eventitem Category by Id
category_id
Verfügbare Endpunkte für Eventitem Comments
Dieser Endpunkt bildet einen speziellen Endpunkt für Kommentare an Veranstaltungen.
Code Block |
---|
https://yourdomain.com/api/v2/eventitems/{eventitem_id}/comments |
GET
Get Eventitem Comments
eventitem_id
POST
Create Eventitem Comment
eventitem_id
PUT
Update Eventitem Comment
comment_id
DELETE
Delete Eventitem Comment
comment_id
Verfügbare Endpunkte für Eventitem Images
Dieser Endpunkt bildet einen speziellen Endpunkt für Bilder von Veranstaltungen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zum Urheber.
Code Block |
---|
https://yourdomain.com/api/v2/eventitems/{eventitem_id}/images |
GET
Get all Images for a specific Eventitem
eventitem_id
Get Eventitem Image by image_id
image_id
POST
Upload Images for a specific Eventitem
eventitem_id
PUT
Update Eventitem Image by image_id
image_id
DELETE
Delete Eventitem Image by image_id
image_id
Release-Notes
Status | ||||
---|---|---|---|---|
|
Excerpt |
---|
Monat 202X - ZusammenfassungText |
Excerpt |
---|
Monat 202X - ZusammenfassungText |
Anleitung zum Setup
Status | ||||
---|---|---|---|---|
|
Historie
change-history
ID des articles / des eventitems zu erhalten, welche dann in den image -Endpunkten verwendet werden kann. |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Beachte auch die Hinweise hier: https://peiq.atlassian.net/wiki/spaces/CORE/pages/44400763/API+Cloud-Connect#Fragen-zu-Bilder-Workflows-%C3%BCber-die-APIs |
Wichtige Hinweise zu Embeds, HTML- & BBCode-Tags im Text bei Importen
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Siehe die entsprechende Dokumentation: Verwendung von HTML- & BBCode-Tags bei Importen |
Wichtige Hinweise zur remote_id
Das PORTAL prüft bei der Beitrags API sowie bei der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 nicht dahingehend, ob die gesendete remote_ID
eindeutig ist. Dies müssen die angeschlossenen Systeme selbst sicherstellen. Sofern die gleiche remote-ID an mehreren Inhalten vergeben ist, berücksichtigt ein Request mithilfe der remote_ID
immer nur ein Item (in der Regel das erste Item in der nach der ID
aufsteigend sortierten Liste).
Bei den image
-Endpunkten der Beitrags API und der https://peiq.atlassian.net/wiki/pages/resumedraft.action?draftId=236028423 wird nur die ID des articles
/ des eventimtems
unterstützt: Die remote-ID
von Beiträgen / Veranstaltungen kann also in den Request-URLs für
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
image
-Endpunkten nicht genutzt werden.Stattdessen kann die remote-ID
des Beitrags / der Veranstaltung im
Status | ||||
---|---|---|---|---|
|
ID
des articles
/ des eventitems
zu erhalten, welche dann in den image
-Endpunkten verwendet werden kann.Trouble Shooting bei HTTP Status Codes
Verwandte Seiten
Filter by label (Content by label) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/lALRAg