Das moPage Module ChatBot bietet dem Website Besucher die Möglichkeit mittels Chat an gewünschte Informationen zu kommen.

Authentifizierung/Request Headers

Die Authentifizierung erfolgt mit einem vorgängig kommunizierten API Key, der im Request Header wie folgt mitzuliefern ist:

X-Api-Key: {client_api_key_here}

Zusätzlich muss der Content-Type auf Application/json gesetzt werden:

 Content-Type: Application/json

Endpoint

URL

POST https://api.mopage.ch/api/v1/chatbot/ask/events 

Body

{
 "datefrom": "yyyy-mm-dd hh:mm:ss",
 "dateto": "yyyy-mm-dd hh:mm:ss",
 "ask": "category term, searchterm...",
 "latitude": 47.123456,
 "longitude": 9.123456
} 

Die Felder ask, latitude und longitude sind dabei fakultativ. Werden die nicht geliefert, werden einfach Events des angegeb. Zeitraums geliefert.

Response

Status Text Beschreibung
200 OK Resultat als JSON, s. unten 
400 Bad Request Input Parameter not valid. ()
401 Unauthorized No permission with provided key.

Resultat

[
    {
    "title": "Konzert Grabenhalle",
    "datefrom": "2018-07-10 20:00:00",
    "dateto": "2018-07-10 23:00:00",
    "urldetails": "https://www.mopage.ch/123456",
    "urlimage": "https://dl.mopage.ch/data/eventimg.jpg",
    "locationinfo": "Grabenhalle\n9000 St.Gallen",
    "latitude": 47.123,
    "longitude": 9.123,
    "categories": ["Rubrik 1", "Rubrik 2"...]
    },
    {},
    ...
]