Öffentliche API¶
Die Endpunkte, die jeder angemeldete Benutzer aufrufen kann: die, mit denen die Apps eine Bibliothek durchstöbern, einen Titel abspielen, Favoriten und Playlists führen und ein Medium anfragen. Eine Datei pro Dienst.
| Spezifikation | Beschreibung |
|---|---|
| library.swagger.json | Bibliotheken, Medien, Suche, Personen; die Projektion public, die die Oberfläche eines Plugins lesen darf |
| playback.swagger.json | Streaming, Fortschritt, Wiedergabeverlauf, Fortsetzen |
| user.swagger.json | Authentifizierung, Profile, API-Schlüssel, Quick Connect |
| collection.swagger.json | Intelligente und manuelle Sammlungen |
| favorite.swagger.json | Favoriten |
| feed.swagger.json | Bereiche der Startseite (Weiterschauen, kürzlich hinzugefügt...) |
| playlist.swagger.json | Playlists, von Hand oder nach Regeln erstellt |
| rating.swagger.json | Bewertungen der Benutzer |
| share.swagger.json | Öffentliche Freigabelinks |
| syncplay.swagger.json | Räume für synchrone Wiedergabe |
| notification.swagger.json | Benachrichtigungen in der App |
| push.swagger.json | Web-Push-Abonnements |
| music.swagger.json | Musikbibliothek (Künstler, Alben, Titel) |
| photo.swagger.json | Fotobibliothek (Alben, Fotos) |
| media_request.swagger.json | Medienanfragen: Suche, Einreichen, Regeln; die Antworten des Administrators und der Zugang zu Anfragen |
Authentifizierung¶
Die Endpunkte erwarten Authorization: Bearer <token>: einen Sitzungstoken
aus der Anmeldung oder einen API-Schlüssel im Rahmen seiner Bereiche
(Server-API). Ohne Token offen: Anmelden und
eine Sitzung erneuern, Registrierung mit einer Einladung, Quick Connect,
Passwort zurücksetzen, der Einrichtungsassistent und sein Status sowie
öffentliche Download-Links.