Api Dokumentation

Version 0.2

In der ersten Version ermöglicht die eveeno-API das Auslesen der Events eines Veranstalters, z.B. zum Aufbau eines Veranstaltungskalenders mit Verlinkung auf die einzelnen Eventsites.


Authentisierung

Methode Rechte
GET /something?userid=12345 User-ID in der URL:
Öffentliche Events des Users lesen
GET /something?userid=12345&api_key=abcdef12345 User-ID und API-Key in der URL:
Öffentliche und private Events des Users lesen
GET /something?userid=12345
X-API-Key: abcdef12345
User-ID in der URL und API-Key im Header:
Öffentliche und private Events des Users lesen

Events

Endpoints

Typ URL Beschreibung
GET https://api.eveeno.com/0.2/events Events suchen und Liste in JSON zurückliefern

Beispiele

Veranstaltungskalender der öffentlichen Events:
GET https://api.eveeno.com/0.2/events?userid=12345

Veranstaltungskalender der öffentlichen und privaten Events:
GET https://api.eveeno.com/0.2/events?userid=12345&scope=all&api_key=abcdef12345

GET https://api.eveeno.com/0.2/events?userid=12345&scope=all&api_key=abcdef12345
HTTP/1.1 200 Ok [ { "id":500, "name":"IT Security Erlangen 2021", "teaser":"DEMO \/\/ Dieses Jahr findet der f\u00fchrende IT-Kongress Bayerns wieder in Erlangen statt. Seien Sie Teil einer Community mit f\u00fchrenden K\u00f6pfen der IT-Szene und erleben Sie spannende Tage mit geb\u00fcndeltem Fach-Know-how in angenehmer Atmosph\u00e4re!", "amount":300, "status":"online", "time_hidden":false, "start":1614880800, "end":1614963600, "location_hidden":false, "loc_name":"Heinrich-Lades-Halle Erlangen", "loc_zipcode":"91052", "loc_city":"Erlangen", "loc_street":"Rathausplatz 1", "loc_country":"Deutschland", "logo_url":"https:\/\/eveeno.com\/public\/generic\/0500\/uploads\/logo.jpg?1478426507", "permalink":"https:\/\/eveeno.com\/333753088", "count":199, "available":101 }, ... (weitere Events) ... ]


Parameter

Parameter Typ Default Pflicht? Beschreibung
userid Integer - ja userid=12345
api_key String - nein api_key=abcdef12345
scope public, private, all public nein Suchraum öffentliche/private Events:
  • public: nur öffentliche Events
  • private: nur private Events (nur mit API-Key)
  • all: alle Events (private nur mit API-Key)
Beispiel: scope=all&userid={USERID}&api_key={API_KEY}
term string - nein Suchwort. Es werden nur Events ausgegeben, die das Suchwort im Namen, in der Beschreibung oder in der Stadt haben. Groß-/Kleinschreibung wird ignoriert.

Beispiel: term=berlin
notterm string - nein Ausschlusswort. Es werden nur Events ausgegeben, die das Ausschlusswort nicht im Namen oder in der Stadt haben. Groß-/Kleinschreibung wird ignoriert.

Beispiel: notterm=intern
period future, past, all future nein Suche nach vergangenen, zukünftigen oder allen Events
order asc, desc asc nein Sortierung, bezogen auf Event-Startzeitpunkt


Antwortfelder (Event-Attribute)

Feld Typ Beschreibung
id Integer Eventnummer
name String Name des Events
teaser String Kurzbeschreibung
permalink URL Dauerhaft gültige URL zur Eventsite
status draft, online, full, offline Event in Arbeit/geöffnet/ausgebucht/geschlossen
amount Integer Anzahl insgesamt vorhandener Plätze
count Integer Anzahl gebuchter Plätze
available Integer Anzahl verfügbarer Plätze
0, wenn ausgebucht
-1, wenn die verfügbare Anzahl Plätze nicht angezeigt werden soll
time_hidden Boolean true, wenn keine Veranstaltungszeit angezeigt werden soll (z.B. Serien-Event mit mehreren Terminen)
start Unix-Timestamp Startzeitpunkt des Events. Eine Uhrzeit von "00:00" bedeutet, das nur ein Datum angegeben ist.
end Unix-Timestamp Endezeitpunkt des Events oder 0, falls keine Endezeit angegeben. Eine Uhrzeit von "00:00" bedeutet, das nur ein Datum angegeben ist
location_hidden Boolean true, wenn kein Veranstaltungsort angezeigt werden soll (z.B. Online-Event)
loc_name String Name des Veranstaltungsortes
loc_zipcode
loc_city
loc_street
loc_country
String Adresse des Veranstaltungsortes
logo_url URL URL zur Logo-Datei des Events (jpg oder png mit 250x250 Pixel)


Steuerparameter beim Aufruf der Eventsite

Eine URL zum Aufruf einer Eventsite kann Parameter enthalten, mit denen z.B. ein Anmeldeformular vorausgefüllt wird oder die Eventsite mit einer bestimmten Seite aufgeblendet wird.


Formular vorab ausfüllen

Parameter Typ Beschreibung
sex sex-m, sex-f, sex-d Anrede Herr, Frau, Divers
title String Akademischer Titel
firstname String Vorname
lastname String Nachname
email String Mailadresse
company String Firma oder Organisation
department String Abteilung
zipcode String Postleitzahl
city String Ort
street String Straße und Hausnummer
{Field-ID} String oder {Field-ID} Benutzerdefiniertes Feld.
Hierbei ist die Nummer des Feldes nötig - bitte mit einem Entwicklertool im DOM nachschlagen oder bei eveeno erfragen.
Beispiel: C181



Support oder Feedback ×
Absenden
Support