alto_events

API

Mit Hilfe dieser API können Sie die Events von einbeck-city.de auf Ihre Website einbinden.

Die Aufrufe müssen über POST erfolgen und den API-Key im Post-Parameter apikey übermitteln. Fehlt der apikey, wird ein Fehler zurückgegeben: 401 Unauthorized.

Momentan hat die API drei Funktionen:

• listEvents
• showEvent
• listEventCategories

listEvents

Liefert die ggf. gefilterten Events als JSON-Objekt.

Aufruf: https://api.einbeck-app.de/index.php?eID=listEvents

Parameter

• limit [999]
• offset [0]
• firstDate [null], und lastDate [null] zur Angabe einer gewünschten Zeitspanne.
  • Angabe des Datums im Format YYYY-MM-DD.
  • Wird kein firstDate angegeben, startet der Export beim aktuellen Datum.
  • Wird kein lastDate angegeben, werden alle nach firstDate liegenden Events geliefert
• categories [""], kommaseparierte Liste der gewünschten Kategorien
  • Angabe durch den Namen der Kategorien (siehe -> listEventCategories)
  • Wird keine Kategorie angegeben, erfolgt keine Einschränkung

Rückgabe

Array [
    - 0 {
        "title": "Eventtitel (string)",
        "sub_title": "Eventuntertitel (string)",
        "description": "Eventbeschreibung (string)",
        "icon": "Pfad zum Vorschaubild (string)",
        "top": Topnachricht (bool),
        "typoId": "Systeminterne Id (string)",
        "id": Eventid (int),
        "allDay": Ganztägiges Event (bool),
        "start": "Startdatum im Format -> DD.MM.YYYY, HH:MM Uhr (string)",
        "start_ts": Startdatum als Timestamp (int),
        "end": "Enddatum im Format -> DD.MM.YYYY, HH:MM Uhr (string)",
        "end_ts": Enddatum als Timestamp (int),
        "images": [
            {
                0 {
                    "path": "Pfad zum Bild (string)",
                    "title": "Bildtitel (string oder null)",
                    "description": "Bildtitel (string oder null)",
                    "hash": "Bildhash (string)",
                    "localfile": "Lokaler Bildname (string)"
                }
            }
        ],
        "categories": "Sonstige, Jugend",
        "promoter": {
            "name": "Veranstalter (string)"
        },
        "location": {
            "name": "Veranstaltungsort (string)",
            "street": "Straße (string)",
            "zip": "PLZ (string)",
            "city": "Stadt (string)",
            "latitude": "Längengrad (string)",
            "longitude": "Breitengrad (string)"
        }
    },
    {...}
]

showEvent

Liefert ein Event als JSON-Objekt.

Aufruf: https://api.einbeck-app.de/index.php?eID=showEvent

Parameter

• event [null] die ID des gewünschten Events

Rückgabe

{
    "title": "Eventtitel (string)",
    "sub_title": "Eventuntertitel (string)",
    "description": "Eventbeschreibung (string)",
    "icon": "Pfad zum Vorschaubild (string)",
    "top": Topnachricht (bool),
    "typoId": "Systeminterne Id (string)",
    "id": Eventid (int),
    "allDay": Ganztägiges Event (bool),
    "start": "Startdatum im Format -> DD.MM.YYYY, HH:MM Uhr (string)",
    "start_ts": Startdatum als Timestamp (int),
    "end": "Enddatum im Format -> DD.MM.YYYY, HH:MM Uhr (string)",
    "end_ts": Enddatum als Timestamp (int),
    "images": [
        {
            0 {
                "path": "Pfad zum Bild (string)",
                "title": "Bildtitel (string oder null)",
                "description": "Bildtitel (string oder null)",
                "hash": "Bildhash (string)",
                "localfile": "26e7b2a31c7e7d3628bf4d49ab80d477a9f3c4d1.jpg"
            }
        }
    ],
    "categories": "Sonstige, Jugend",
    "promoter": {
        "name": "Veranstalter (string)"
    },
    "location": {
        "name": "Veranstaltungsort (string)",
        "street": "Straße (string)",
        "zip": "PLZ (string)",
        "city": "Stadt (string)",
        "latitude": "Längengrad (string)",
        "longitude": "Breitengrad (string)"
    }
}

listEventCategories

Liefert die aktuellen Kategorien als JSON-Objekt.

Aufruf: https://api.einbeck-app.de/index.php?eID=listEventCategories

Parameter keine

Rückgabe

Array [
    "categories": [
        {
            "uid": Id der Kategorie (int),
            "title": "Kategorietitel (string)"
        },
        {...}
]