API - Schnittstelle für Entwickler

Terminhelden bietet eine Rest-API für die Integrationen anderer Anwendungen an.
Die Autorisierung erfolgt über einen API-Token, der vom Moderator eines Kalenders erstellt werden kann.
Die API befindet sich in ständiger Entwicklung und kann jederzeit Änderungen unterliegen. Soweit dies möglich ist, bleiben alte Schnittstellen aber stabil. Änderungen, die eine Neuimplementierung einer Schnittstelle bedeuten, äußern sich in einer neuen Version der Schnittstelle.

Authentifizierung

Der Zugriff auf die API erfolgt über einen Token. Dieser Token kann nur einmalig vom Moderator eines Kalenders erstellt werden.

API Aufrufe

Termine
GET: /api/v1/events
Der Aufruf gibt alle zukünftigen Termine zurück.
Parameter
keine
Beispiel
curl https://www.terminhelden.de/api/v1/events?token=api-token
Ausgabe

[
    {
        "title": "Das ist ein Termin",
        "description": "Wir treffen uns wie immer",
        "date": "2019-01-24T18:00:00.000+0000",
        "state": "Termin findet statt",
        "stateid": 0,
        "registrations": 4,
        "waiting": 0,
        "deregistrations": 6,
        "outstanding": 17
    },
]
							
Beschreibung
title
Titel des Termins
description
Beschreibung des Termins
date
Datum des Termins im Format yyyy-MM-dd HH:mm:ss.S
state
Titel des Status eines Termins
stateid
id des Status. 1=Termin findet statt, 2=Termin findet nicht statt, 3=Termin findet noch nicht statt
registrations
Anzahl der Anmeldungen
waiting
Anzahl Anmeldungen in der Warteliste
deregistrations
Anzahl der Abmeldungen
outstanding
Anzahl der Nicht-Meldungen