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.
Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert.
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
Grundsätzliches zur Veranstaltungs API
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
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
Response
{
"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",
"url_qr": "https://www.example.com/event/qr/eventitem/1",
"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"
},
"event_locations": [
{
"type": "loc",
"name": "string",
"street": "string",
"city": "string",
"zipcode": "string",
"lat": "Unknown Type: float",
"lng": "Unknown Type: float",
"url": "string",
"gplid": "string",
}
],
"embeds": {
"embedcode": {
"e3rux4b8nc0": {
"content": "<b>Bold</b>"
}
}
},
"embed_type_count": {
"map": 1,
"video": 1,
"social": 1
},
"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": "[embedcode=e3rux4b8nc0][/embedcode][tiktok]https://www.tiktok.com/@example/video/0001[/tiktok][map]https://www.google.com/maps/embed?params[/map][video]https://www.youtube.com/watch?v=9CDs067081E[/video]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"
]
}
]
}
POST
Create Eventitem
PUT
Update Eventitem by Id
eventitem_id
DELETE
Delete Eventitem by Id
eventitem_id
Request Body
{
"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"
]
}
Verfügbare Endpunkte für Eventitem Categories
Dieser Endpunkt bildet einen speziellen Endpunkt zum einfacheren Auslesen der Veranstaltungs-Kategorien.
https://yourdomain.com/api/v2/eventitems/categories
GET
Get All Eventitem Categories
Get Eventitem Category by Id
category_id
Response
[
{
"id": "1",
"name": "Sport",
"name_norm": "sport"
}
]
Verfügbare Endpunkte für Eventitem Comments
Dieser Endpunkt bildet einen speziellen Endpunkt für Kommentare an Veranstaltungen.
https://yourdomain.com/api/v2/eventitems/{eventitem_id}/comments
GET
Get Eventitem Comments
eventitem_id
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"author_id": 1,
"text": "This is a test comment!",
"status": "published",
"position": "1",
"created": "2019-03-07T00:00:00+00:00",
"updated": "2019-03-07T00:00:00+00:00"
}
]
}
POST
Create Eventitem Comment
eventitem_id
PUT
Update Eventitem Comment
comment_id
DELETE
Delete Eventitem Comment
comment_id
Request Body
[
{
"author_id": 1,
"text": "This is a test comment!",
"created": "2019-03-07T00:00:00+00:00"
}
]
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.
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
Response
[
{
"id": "1",
"url_set": {
"NATIVE": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_NATIVE.jpg",
"T": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_T.jpg",
"XS": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XS.jpg",
"S": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_S.jpg",
"M": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_M.jpg",
"L": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_L.jpg",
"XL": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XL.jpg",
"XXL": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XXL.jpg"
},
"user_id": 1,
"created": "2019-03-07T00:00:00+00:00",
"modified": "2019-03-07T00:00:00+00:00",
"caption": "Test Image Caption",
"copyright": "Test Image Copyright",
"focus_x": "2",
"focus_y": "3"
}
]
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
Request Body
[
{
"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"
}
]
Trouble Shooting bei HTTP Status Codes
Verwandte Seiten
Disclaimer
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.