Event API
Event API
Die Event API ermöglicht externen Anwendungen, Anmeldungen für deine Veranstaltung zu verwalten. Dies ist nützlich für die Integration mit einem Anmeldesystemen, Live-Diensten oder sonstigen, eigenen Tools.
API-Zugangsdaten abrufen
- Navigiere zu Ergebnisse
- Öffne das Menü (☰)
- Klicke auf API key
- Du siehst zwei Werte:
- API-ID: Deine Veranstaltungs-ID
- API-Key: Ein Token, einzigartig für deine Veranstaltung
Du benötigst beide Werte für API-Anfragen.
Authentifizierung
Alle API-Anfragen müssen den API-Key im Authorization-Header enthalten:
Authorization: <api-key>
Die Veranstaltungs-ID wird als Pfadparameter in der URL übergeben.
Wenn der Token fehlt oder ungültig ist, gibt der Server Status 404 zurück.
Endpunkte
Alle Anmeldungen auflisten
GET o-timing.ch/api/v1/entries/:event
Gibt alle Anmeldungen für die Veranstaltung zurück.
Antwort (200):
[
{
"id": "string",
"name": "string",
"cardNumber": 0,
"class": "string"
}
]
| Feld | Beschreibung |
|---|---|
| id | Teilnehmer-ID |
| name | Anmelde-/Teamname |
| cardNumber | SI-Kartennummer |
| class | Kategoriename (oder <unknown> falls Kategorie nicht gefunden) |
Fehler:
| Status | Grund |
|---|---|
| 404 | Veranstaltung nicht gefunden oder ungültiger API-Token |
Anmeldung erstellen oder aktualisieren
PUT o-timing.ch/api/v1/entries/:event/:id
Erstellt einen neuen Teilnehmer, wenn die ID nicht existiert, oder aktualisiert den bestehenden.
Pfadparameter:
| Param | Beschreibung |
|---|---|
| event | Veranstaltungs-ID (deine API-ID) |
| id | Anmelde-ID (der Server stellt intern das Veranstaltungs-Präfix voran) |
Request Body:
{
"id": "string",
"name": "string",
"members": [
{
"firstname": "string",
"lastname": "string",
"birthyear": 0,
"female": false,
"town": "string",
"mobile": "string (optional)",
"mail": "string (optional)"
}
],
"cardNumber": 0,
"cardRented": false,
"club": "string",
"class": "string",
"bib": 0
}
Wichtige Hinweise:
- class muss der Kategorie-Name sein. Wenn der Kategoriename nicht gefunden wird, gibt die Anfrage
400zurück. - members ist ein Array von Teammitgliedern. Bei Aktualisierung werden bestehende Mitglieder der Reihe nach gepatcht — zusätzliche Mitglieder werden hinzugefügt, überschüssige Mitglieder werden entfernt.
- bib wird nur angewendet, wenn vorhanden und eine Zahl.
- mobile und mail sind optionale Felder pro Mitglied.
Antwort:
| Status | Bedeutung |
|---|---|
| 200 | Anmeldung erfolgreich erstellt oder aktualisiert |
| 400 | Kategoriename für diese Veranstaltung nicht gefunden |
| 404 | Veranstaltung nicht gefunden oder ungültiger API-Token |