thies
1 line
16 KiB
JSON
1 line
16 KiB
JSON
{"config":{"lang":["de"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"RegattaTech.DE Doku","text":"<p>Willkommen auf der Doku Seite von RegattaTech.DE</p> <p>Hier findest du Dokumentation zu unseren Systemen.</p> <p>Sollten irgendwelche Fragen nicht beantwortet werden, wende dich gerne an unser Support Team unter hi@regattatech.de</p> <p></p> <p> Legal</p>"},{"location":"API/","title":"API","text":"<p>Die Core Applikation publiziert verschiedenste Daten \u00fcber eine API.</p> <p>Die API ist in 2 Bereiche unterteilt.</p> <ul> <li>Eine \u00f6ffentliche Read-Only API welche Ergebnisse & Informationen Rund um die Regatta publiziert. Diese nutzen wir an verschiedensten Stellen, zB:</li> <li>WebApp</li> <li>Apps</li> <li> <p>Bots</p> </li> <li> <p>Eine private Read-Write API die mit dem Core System kommuniziert. Diese nutzen wir nur, wenn ein Schreibzugriff ben\u00f6tigt wird, zB:</p> </li> <li>Ergebnisse automatisiert eintragen</li> <li>Pager ausl\u00f6sen</li> <li>Boote anlegen/editieren</li> </ul> <p>Die \u00f6ffentliche API wird hier dokumentiert. Die Dokumentation der privaten API steht f\u00fcr unsere Kund*\\innen oder auf Anfrage zur Verf\u00fcgung.</p>"},{"location":"API/02_public/","title":"Public API","text":"<p>Folgende API Endpunkte stellen wir zur Verf\u00fcgung:</p>"},{"location":"API/02_public/#allgemeine-erklarungen","title":"Allgemeine Erkl\u00e4rungen","text":"<ul> <li> <p>Die \u00f6ffentliche API befindet sich meistens unter <code>https://api.<tennant>.regattatech.de</code>, kann aber je nach Wunsch auch unter einer anderen Domain publiziert werden.</p> </li> <li> <p>\"\u00f6ffentliche API\" meint in dem Zusammenhang, dass kein API Key ben\u00f6tigt wird. Es k\u00f6nnen jedoch IP Beschr\u00e4nkungen oder andere Sicherheitsvorkehrungen f\u00fcr bestimmte Endpunkte definiert sein.</p> </li> <li> <p>Die Endpunkte enden meistens mit einem <code>/current/</code> dies spezifiziert die aktuellste Regatta. Sollte eine andere Regatta gew\u00fcnscht werden, kann diese mit der laufenden Regatta ID anstelle von <code>/current/</code> gew\u00e4hlt werden (zB <code>/2/</code>)</p> </li> </ul>"},{"location":"API/02_public/#apiv1bootlistecurrent","title":"/api/v1/bootliste/current/","text":""},{"location":"API/02_public/#aufbau","title":"Aufbau","text":"<p>Gibt in einem strukturierten JSON folgende Informationen aus:</p> <ul> <li>Eindeutige Boot-ID</li> <li>Name des Bootes</li> <li>Ggf. ehemalige Namen des Bootes</li> <li>Ob das betreffende Boot ein Jugendboot ist</li> <li>Wer an der Trommel sitzt</li> <li>Wer \"Auf Schlag\" sitzt</li> <li>Woher das Team kommt</li> <li>Wie sich das Team definiert</li> <li>Bisherige Platzierungen</li> <li>Ob dies die erste Teilnahme ist</li> <li>Wie h\u00e4ufig schon teilgenommen wurde</li> <li>Ziele bei der Regatta</li> <li>Was das Team auszeichnet</li> <li>Schlachtruf des Teams</li> <li>Notizen zum Team</li> <li>Status des Teams (Ver\u00f6ffentlicht J/N)</li> <li>Pager ID des Teams</li> <li>Link zum Teambild</li> </ul> <p>Die Infos in Kursiv werden ggf. nur bestimmten Endpunkten mitgeteilt und sind haupts\u00e4chlich f\u00fcr Internetpr\u00e4senzen und Moderation gedacht.</p>"},{"location":"API/02_public/#verwendung","title":"Verwendung","text":"<ul> <li>Apps</li> <li>Moderation</li> <li>Webseiten</li> </ul>"},{"location":"API/02_public/#apiv1message","title":"/api/v1/message","text":""},{"location":"API/02_public/#aufbau_1","title":"Aufbau","text":"<p>Gibt in einem strukturierten JSON folgende Informationen aus:</p> <ul> <li>Nachricht</li> <li>Wichtigkeit der Nachricht</li> </ul>"},{"location":"API/02_public/#verwendung_1","title":"Verwendung","text":"<ul> <li>Apps</li> <li>Webseiten</li> <li>Moderation</li> <li>Push</li> </ul>"},{"location":"API/02_public/#apiv1rennplancurrent","title":"/api/v1/rennplan/current/","text":""},{"location":"API/02_public/#aufbau_2","title":"Aufbau","text":"<p>Gibt in einem strukturierten JSON folgende Informationen aus:</p> <ul> <li>Rennplan nach Lauf und Rennen</li> <li>UUID des jeweiligen Rennens</li> <li>Teilnehmende Boote nach Bahn des jeweiligen Rennens</li> <li>Zeitpunkt des jeweiligen Rennens</li> <li>Name des jeweiligen Rennens</li> <li>Laufende Nummer des jeweiligen Rennens</li> <li>Art des jeweiligen Rennens</li> </ul>"},{"location":"API/02_public/#verwendung_2","title":"Verwendung","text":"<ul> <li>Apps</li> <li>Webseiten</li> <li>Moderation</li> </ul>"},{"location":"API/02_public/#apiv1resultscurrent","title":"/api/v1/results/current/","text":""},{"location":"API/02_public/#aufbau_3","title":"Aufbau","text":"<p>Gibt in einem strukturierten JSON folgende Informationen aus:</p> <ul> <li>Ergebnisse nach Rennen</li> <li>UUID des jeweiligen Rennens</li> <li>Teilnehmende Boote nach Bahn des jeweiligen Rennens</li> <li>Gefahrene Zeit des Bootes nach Bahn & Rennen</li> <li>Zeitpunkt des jeweiligen Rennens</li> <li>Name des jeweiligen Rennens</li> <li>Laufende Nummer des jeweiligen Rennens</li> <li>Art des jeweiligen Rennens</li> </ul>"},{"location":"API/02_public/#verwendung_3","title":"Verwendung","text":"<ul> <li>Apps</li> <li>Webseiten</li> <li>Moderation</li> </ul>"},{"location":"API/02_public/#besonderheiten","title":"Besonderheiten","text":"<p>In bestimmten Modi werden w\u00e4hrend des letzten Laufes keine Ergebnisse \u00fcber diese API publiziert!</p>"},{"location":"API/03_private/","title":"Private API","text":"<p>Da die private API kundenspezifisch entwickelt und betrieben wird, gibt es keine \u00f6ffentliche Dokumentation dieser API</p>"},{"location":"Apps/","title":"Apps","text":"<p>F\u00fcr die Ergebnispr\u00e4sentation und Rennpl\u00e4ne haben wir Apps entwickelt, welche die Daten darstellen. Diese sind Push f\u00e4hig und beziehen ihre Daten direkt von der API des Core Systems.</p> <p>Aktuell k\u00f6nnen wir Apps f\u00fcr folgende Plattformen bereitstellen:</p> <ul> <li>Android (Google Play Store)</li> <li>iOS / iPadOS / macOS (Apple AppStore)</li> <li>Web</li> </ul>"},{"location":"Apps/02_android/","title":"Android App","text":"<p>Unsere Android App ist in flutter entwickelt. Sie unterst\u00fctzt folgende Features:</p> <ul> <li>Ergebnisse</li> <li>Rennpl\u00e4ne</li> <li>Push Benachrichtigungen (firebase)</li> </ul>"},{"location":"Apps/02_ios/","title":"iOS App","text":"<p>Unsere iOS App ist nativ in Swift entwickelt. Sie unterst\u00fctzt folgende Features:</p> <ul> <li>Ergebnisse</li> <li>Rennpl\u00e4ne</li> <li>Push Benachrichtigungen (apns2)</li> </ul>"},{"location":"Apps/03_web/","title":"Web App","text":"<p>Unsere Web App ist in HTML & JS entwickelt. Sie unterst\u00fctzt folgende Features:</p> <ul> <li>Ergebnisse</li> <li>Rennpl\u00e4ne</li> </ul>"},{"location":"Core/","title":"Core Applikation","text":"<p>Die Core Applikation ist modular aufgebaut und enth\u00e4lt verschiedene Bereiche.</p>"},{"location":"Core/02_regatta/","title":"Regatta Anlegen","text":"<p>Klicke als erstes auf Regatta anlegen</p> <p></p> <p>Es \u00f6ffnet sich eine Eingabemaske.</p> <p>F\u00fclle mindestens alle Felder aus, die mit einem Roten Pfeil markiert sind.</p> <p></p> <p></p> <p>Die Regatta ist angelegt und wird automatisch geladen. Dort k\u00f6nnen nun Boote hinzugef\u00fcgt werden, oder die Regatta editiert werden.</p> <p></p>"},{"location":"Core/03_boote_anlegen/","title":"Boote Anlegen","text":"<p>Boote Anlegen funktioniert aktuell nur \u00fcber die Admin Ansicht!</p> <p>Boote k\u00f6nnen aktuell nur \u00fcber unsere Shop-Integration oder manuell angelegt werden.</p> <p>Wir sind aber bereits dabei das zu \u00e4ndern!</p>"},{"location":"Core/04_boote_zuweisen/","title":"Boote Zuweisen","text":"<p>In der Regatta Ansicht, scrolle nach unten und w\u00e4hle \"Boote zuweisen\" aus.</p> <p></p> <p>W\u00e4hle dann alle Boote aus die zugewiesen werden sollen. Oben erscheint ein Counter wie viele Boote zugewiesen sind und wie viele maximal zugewiesen werden k\u00f6nnen. Dieser Counter \u00e4ndert updated sich live, damit du immer den \u00dcberblick hast wie viele Boote du noch zuweisen kannst. Klicke am Ende auf \"Boote zuweisen\" um die Boote der Regatta zuzuweisen </p>"},{"location":"Core/05_boote_sortieren/","title":"Lauf 1 Erstellen / Boote in Rennen sortieren","text":"<p>Um den Lauf 1 zu erstellen dr\u00fccke in der Regatta nach dem ausreichend Boote zugewiesen sind auf \"Lauf auff\u00fcllen\"</p> <p></p> <p>Dadurch wird der Lauf zuf\u00e4llig mit den zugewiesenen Booten gef\u00fcllt.</p>"},{"location":"Core/05_boote_sortieren/#boote-manuell-verschieben","title":"Boote manuell verschieben","text":"<p>Um die Boote nach dem erstellen des Lauf 1 manuell zu sortieren, klicke auf den Lauf.</p> <p></p> <p>Scrolle nach unten und klicke auf \"Boote neu auf Bahnen sortieren\"</p> <p></p> <p>Nun kannst du per Drag & Drop die Boote neu in Rennen & Bahnen sortieren.</p> <p></p> <p>Scrolle am Ende nach unten und klicke auf \"Speichern\"</p> <p>Solltest du Boote entfernt haben und nicht mehr alle L\u00e4ufe vollst\u00e4ndig sein, klicke auf \"Trotzdem Speichern\"</p> <p></p>"},{"location":"Core/06_rennplan_drucken/","title":"Rennplan ausdrucken / als PDF exportieren","text":"<p>Um den Rennplan auszudrucken oder als PDF zu exportieren dr\u00fccke auf den \"Drucker\"-Button neben dem Lauf</p> <p></p> <p>Dann \u00f6ffnet sich automatisch der Rennplan im praktischen PDF Format und kann entweder gedruckt oder gespeichert werden</p> <p></p>"},{"location":"Core/07_zeiten_erfassen/","title":"Zeiten erfassen","text":"<p>Um Zeiten zu erfassen klicke auf den aktuellen Lauf</p> <p></p> <p>Klicke dann auf das Rennen f\u00fcr das du die Zeiten erfassen m\u00f6chtest</p> <p></p> <p>Trage die Zeiten ein und klicke anschlie\u00dfend auf \"Ergebnis speichern\" </p> <p>Zur Best\u00e4tigung wird das Ergebnis angezeigt. Gleichzeitig wird (wenn verf\u00fcgbar) die Benachrichtigung via Push Benachrichtigung an Apps & Schnittstellen \u00fcbertragen. </p>"},{"location":"Schnittstellen/","title":"Schnittstellen","text":"<p>Wir betreiben verschiedene Schnittstellen, welche auf Wunsch & nach Bedarf zur Verf\u00fcgung gestellt werden k\u00f6nnen.</p>"},{"location":"Schnittstellen/Ergebnis%20Monitore/","title":"Ergebnis Monitore","text":"<p>Wir bieten an, auf Wunsch ein System zu betreiben, welches mit Informationen aus der \u00f6ffentlichen API informatioen abruft und auf gro\u00dfen Bildschirmen (zB Fernsehern/Beamern/LED W\u00e4nden) diese Informationen anzeigt.</p> <p>Dieses System ist darauf optimiert keine Nutzereingaben zu erfordern (scrollt zB automatisiert durch die Ergebnisse)</p>"},{"location":"Schnittstellen/Moderation/","title":"Moderationstools","text":"<p>Wir bieten unterschiedliche Moderationstools an.</p> <p>Diese liefern Informationen zur aktuellen Regatta, die M\u00f6glichkeit Teams \u00fcber die Pager Systeme zu informieren, sowie die M\u00f6glichkeit weitere Informationen f\u00fcr die Moderator*\\innen zur Verf\u00fcgung zu stellen um eine m\u00f6glichst fl\u00fcssige Moderation zu liefern.</p>"},{"location":"Schnittstellen/Pager/","title":"Pager","text":"<p>Unser Pagersystem bindet sich in unsere Core Applikation ein.</p> <p>Es k\u00f6nnen auf einer Regatta an Teams Pager ausgegeben werden, welche zu definierbaren Zeitpunkten vibrieren und ein akustisches Signal von sich geben.</p> <p>Die Pager arbeiten auf dem 433.92MHz Band und werden von einem lokalen System, mit mehreren Relays gesteuert.</p>"},{"location":"Schnittstellen/Pager/02_pager/","title":"Pager benutzen","text":"<p>Aktuell unterst\u00fctzen wir Pager nur bei einer Full Service Regatta, das hei\u00dft wenn wir vor Ort sind und das System betreuen.</p> <p>Grund daf\u00fcr ist, dass die Pager Relays und sende Stationen vor Ort aufgebaut werden m\u00fcssen und Konfiguration ben\u00f6tigen.</p> <p>Solltet ihr ein eigenes Pager System besitzen, welches eine API Integration bietet, k\u00f6nnen wir bei Bedarf dieses System implementieren.</p>"},{"location":"Schnittstellen/Push/","title":"Push","text":"<p>Das Core System kann (wenn konfiguriert) zu definierbaren Zeitpunkten Push Benachrichtigungen verschicken. Daf\u00fcr versendet das System an unsere Push Schnittstelle die Benachrichtigung.</p> <p>Diese sendet dann die Benachrichtigung an die verschiedenen Kan\u00e4le.</p> <p>Folgende Kan\u00e4le werden aktuell unterst\u00fctzt:</p> <ul> <li>Apple iOS / iPadOS / macOS</li> <li>Android</li> <li>Telegram</li> </ul>"},{"location":"Schnittstellen/Push/02_telegram/","title":"Telegram Bot","text":"<p>Wir bieten an, einen Telegram Bot zu betreiben. Dieser bietet neben Push Benachrichtigungen auch die M\u00f6glichkeit Interaktiv den Rennplan abzurufen.</p> <p>Regatta Ergebnisse als Push Benachrichtigung: </p> <p>Interaktiver Bot f\u00fcr Rennpl\u00e4ne: </p> <p></p> <p></p>"},{"location":"Schnittstellen/Wordpress/","title":"Wordpress","text":"<p>Wir bieten mehrere Schnittstellen f\u00fcr das CMS \"WordPress\" an. Diese bedienen sich an der Public API und bieten so eine interaktive M\u00f6glichkeit die Webseite auszugestalten.</p>"},{"location":"Schnittstellen/Wordpress/02_teams/","title":"Team Pr\u00e4sentation","text":"<p>\u00dcber unser Team Sync Plugin, bieten wir die M\u00f6glichkeit auf einer WordPress Seite Informationen zu den Teams anzuzeigen.</p> <p>Das Plugin erh\u00e4lst du bei unserem Support.</p>"},{"location":"Schnittstellen/Wordpress/03_rennplan/","title":"Rennpl\u00e4ne","text":"<p>\u00dcber unser Rennplan Sync Plugin, bieten wir die M\u00f6glichkeit auf einer WordPress Seite die aktuellen Rennpl\u00e4ne einer Regatta anzuzeigen.</p> <p>Das Plugin erh\u00e4lst du bei unserem Support.</p>"},{"location":"Weiteres/","title":"Weitere Services","text":"<p>Auf Wunsch bieten wir weitere Services an. Diese sind hier dokumentiert.</p> <p>Die spezifische Dokumentation f\u00fcr einzelne Services befindet sich ggf. an einem anderen Ort.</p>"},{"location":"Weiteres/02_vorverkauf/","title":"Vorverkauf","text":"<p>Wir bieten an den Vorverkauf eurer Regatta zu organisieren.</p> <p>Dies umfasst die Konfiguration & den Betrieb eines Shop Systems (auf Wunsch mit eigener Domain) welches von Vorverkauf, \u00fcber bestimmte Abfragen, bis hin zur Zahlungsabwicklung und Rechnungserstellung alles \u00fcbernehmen kann.</p> <p>Wir setzen daf\u00fcr auf die Software \"pretix\" </p>"},{"location":"Weiteres/03_rennleitung/","title":"Rennleitung","text":"<p>Nat\u00fcrlich kommen wir gerne vorbei und betreuen die Regatta vor Ort. Mit unserer jahrelanger Erfahrung bieten wir die M\u00f6glichkeit den Ablauf der Regatta an uns und unsere Partner auszulagern.</p>"},{"location":"Weiteres/04_internet/","title":"Internet Vor-Ort","text":"<p>Wir wissen. So ein tolles Setup bringt nichts, wenn dann kein Internet vor Ort zur Verf\u00fcgung steht.</p> <p>Daher bieten wir an die Zeiterfassung / Rennleitung direkt mit ins Internet zu bringen.</p> <p>Egal ob DSL, LTE, 5G oder Sattelitenverbindung, wir bringen das System online.</p> <p>DSL Verbindung muss vom Veranstalter gestellt werden, andere Systeme k\u00f6nnen bei uns geliehen werden</p>"},{"location":"Weiteres/05_multimedia/","title":"Photos & Videos","text":"<p>Auf Wunsch dokumentieren wir die Regatta f\u00fcr euch.</p> <p>Mit Drohnen, Videokameras & Photokameras sind wir f\u00fcr euch vor Ort und filmen & photografieren die Regatta und den Trubel drum herum.</p> <p>Gerne schneiden wir die Videos danach zu einem kurzen Video zusammen, oder bearbeiten die Photos im Nachgang.</p> <p>Sprecht uns einfach an!</p>"},{"location":"Weiteres/05_multimedia/#beispiel-videos","title":"Beispiel Videos:","text":"<ul> <li>Sport am Tankumsee 2024</li> <li>Sport am Tankumsee 2026</li> </ul>"},{"location":"Weiteres/05_multimedia/#photobox","title":"Photobox","text":"<p>Auf Wunsch stellen wir vor Ort eine Photobox auf. An dieser k\u00f6nnen eure Besucher*\\innen Photos machen, diese per QR-Code abrufen oder sich (auf Wunsch) direkt ausdrucken lassen.</p> <p>Sprecht uns auch daf\u00fcr gerne an!</p>"},{"location":"Weiteres/06_websites/","title":"Webseiten","text":"<p>Noch keine eigene Webseite?</p> <p>Oder schon, aber seit jahren nichts mehr dran gemacht?</p> <p>Wir bieten euch an, zusammen mit unseren Partnerfirmen die Webseite zu \u00fcberarbeiten und direkt unsere Systeme zu integrieren.</p>"}]} |