doku/docs/API/index.md

hide

hide
footer

API

Die Core Applikation publiziert verschiedenste Daten über eine API.

Die API ist in 2 Bereiche unterteilt.

• Eine öffentliche Read-Only API welche Ergebnisse & Informationen Rund um die Regatta publiziert. Diese nutzen wir an verschiedensten Stellen, zB:

  • WebApp
  • Apps
  • Bots

• Eine private Read-Write API die mit dem Core System kommuniziert. Diese nutzen wir nur, wenn ein Schreibzugriff benötigt wird, zB:

  • Ergebnisse automatisiert eintragen
  • Pager auslösen
  • Boote anlegen/editieren

Die öffentliche API wird hier dokumentiert. Die Dokumentation der privaten API steht für unsere Kund*\innen oder auf Anfrage zur Verfügung.