FRET Public API

Über die FRET Public API können Informationen aus FRET an einer öffentlich zugänglichen Schnittstelle abgerufen werden. Dies ermöglicht z.B. die Integration in Partnersoftware oder Eigenentwicklungen.

Aktivierung & Konfiguration

Die FRET Public API muss in den Einstellungen von FRET X aktiviert werden und wird nicht zentral gespeichert. Somit kann gesteuert werden, welcher PC die Daten an die FRET Public API überträgt. Nach dem Aktivieren muss FRET X neu gestartet werden.

Eingebaute Dienste der pasoma UG (haftungsbeschränkt)

FRET Player View

Neben der Integration in Partnersoftware kann die FRET Public API auch dazu genutzt werden, um die folgenden Dienste der pasoma UG (haftungsbeschränkt) zu nutzen.

Die FRET Player View ermöglicht es, die Song und Tanzinformationen des aktuell gespielten Songs und der jeweils folgenden Songs aus der Playlist im Browser anzuzeigen. Dies kann beispielsweise über einen Fernseher oder Beamer genutzt werden, um den Kunden in Kurspausen oder während Tanzparties die Information zur Verfügung zu stellen.

FRET Player View

FRET Web Fernbedienung

Mit der FRET Web Fernbedienung ist es möglich, die Player von FRET über ein Smartphone oder Tablet fernzusteuern.

Aktivieren der FRET Web Fernbedienung

Sobald FRET mit aktiviertem Plugin gestartet wurde und sich mit dem Server verbinden konnte, kann der QR-Code abgerufen werden. Der QR-Code ist rechts unten in der Fußleiste über das Fernbedienungs-Icon erreichbar.

QR-Code für die FRET Web Fernbedienung

Bei jedem Start von FRET wird ein neuer QR-Code erzeugt, der erneut gescannt werden muss. Der alte QR-Code wird ungültig, sobald FRET geschlossen wird.

Sollte die Internetverbindung am PC unterbrochen werden, wird der QR-Code ebenfalls ungültig und nach Wiederherstellen der Internetverbindung muss der neue QR-Code gescannt werden.

Sollte die Internetverbindung am Smartphone oder Tablet abbrechen, versucht die Fernbedienung die Verbindung zu FRET erneut aufzubauen. Sollte dies nicht funktionieren, bitte die Seite neu laden oder den QR-Code neu scannen.

Funktionen der FRET Web Fernbedienung

Wird der QR-Code mit dem Smartphone oder Tablet gescannt, öffnet sich automatisch die FRET Web Fernbedienung und die Steuerung der Player kann über einen Tap auf "Start" begonnen werden.

Startbildschirm der FRET Web Fernbedienung

In der FRET Web Fernbedienung kann wie gewohnt zwischen den Playern gewechselt werden und es stehen die folgenden Funktionen zur Verfügung:

• Stoppen des aktuellen Songs

• Starten / Pausieren des aktuellen Songs

• Weiter zum nächsten Song

Zugriff auf die FRET Public API

Um selbst auf die Daten der FRET Public API zuzugreifen oder eine Partnersoftware Zugriff zu gewähren, werden die folgenden Informationen benötigt, die nach dem Aktivieren und Neustarten in den FRET-Einstellungen angezeigt werden.

FRET Public API Verbindungsdaten

Die Verbindungsdaten müssen vertraulich behandelt werden, da mit Ihnen alle an der Public API zur Verfügung stehenden Daten abgerufen werden können. Es ist nicht auszuschließen, dass hierbei auch persönliche Daten laut DSGVO enthalten sind.

Beim Austausch eines Computers ist darauf zu achten, dass sich die Computer-ID ändert. Somit ist diese auch in den entsprechenden Integrationen zu aktualisieren

In FRET X werden aktuell noch keine Song-Covers übertragen. Dies wird in späteren Versionen ergänzt.

Für komplexere Anwendungsfälle (z.B. gleichzeitige Anzeige von Tanzkursinformationen, Saalbelegungen, Social-Media-Content etc.) stehen die Produkte unserer Kooperationspartner zur Verfügung:

• https://nimbuscloud.at/

• https://screen-it.at/

• https://ts-screen.de/

API Dokumentation

Um in Webanwendungen Zugriff auf die API zu bekommen, bitte eine Anfrage an [email protected] senden, damit die entsprechenden CORS-Einstellungen unsererseits vorgenommen werden können.

RESTful API

Die technische API Dokumentation ist unter https://fret-api.azurewebsites.net/swagger/index.html zu finden und kann zum Entwickeln eigener Lösungen genutzt werden. Bei Fragen zu den Endpunkten oder Funktionswünschen bitte den FRET Support kontaktieren.

SignalR

Neben der RESTful API steht auch eine API via SignalR zur Verfügung. Bei Fragen zu den Endpunkten oder Funktionswünschen bitte den FRET Support kontaktieren.

PlayerHub

Der PlayerHub stellt Informationen über die Songs im Player zur Verfügung stellt. Details unter https://fret-api.azurewebsites.net/signalr-dev/index.html.

/* THIS (.ts) FILE IS GENERATED BY Tapper */
/* eslint-disable */
/* tslint:disable */

/** Transpiled from FRET.Cloud.Public.Abstractions.Dtos.PlayerIdentifierDto */
export type PlayerIdentifierDto = {
    /** Transpiled from System.Guid */
    schoolId: string;
    /** Transpiled from System.Guid */
    computerId: string;
    /** Transpiled from int */
    playerNumber: number;
}

/** Transpiled from FRET.Cloud.Public.Abstractions.Dtos.PlayerInfoDto */
export type PlayerInfoDto = {
    /** Transpiled from bool */
    isPlaying: boolean;
    /** Transpiled from System.Collections.Generic.List<FRET.Cloud.Public.Abstractions.Dtos.PlayerSongInfoDto> */
    songs: PlayerSongInfoDto[];
}

/** Transpiled from FRET.Cloud.Public.Abstractions.Dtos.PlayerSongInfoDto */
export type PlayerSongInfoDto = {
    /** Transpiled from int */
    position: number;
    /** Transpiled from System.Guid */
    songId: string;
    /** Transpiled from System.DateTimeOffset */
    startTime?: (Date | string);
    /** Transpiled from string */
    title: string;
    /** Transpiled from string */
    artist: string;
    /** Transpiled from string */
    dancesShort: string;
    /** Transpiled from string */
    dancesLong: string;
    /** Transpiled from double */
    duration: number;
    /** Transpiled from int */
    year: number;
    /** Transpiled from string */
    comment: string;
    /** Transpiled from string? */
    coverImageUrl?: string;
}