API publique¶
Les points d'accès que tout utilisateur connecté peut appeler : ceux que les applications utilisent pour parcourir une bibliothèque, lire un titre, gérer des favoris et des playlists, et demander un média. Un fichier par service.
| Spécification | Contenu |
|---|---|
| library.swagger.json | Bibliothèques, médias, recherche, personnes ; la projection public que l'interface d'un plugin peut lire |
| playback.swagger.json | Streaming, suivi de progression, historique de lecture, reprise |
| user.swagger.json | Authentification, profils, clés API, Quick Connect |
| collection.swagger.json | Collections intelligentes et manuelles |
| favorite.swagger.json | Favoris |
| feed.swagger.json | Sections de l'accueil (reprendre la lecture, ajouts récents...) |
| playlist.swagger.json | Playlists, faites à la main ou par règles |
| rating.swagger.json | Notes des utilisateurs |
| share.swagger.json | Liens de partage publics |
| syncplay.swagger.json | Salons de lecture synchronisée |
| notification.swagger.json | Notifications dans l'application |
| push.swagger.json | Abonnements aux notifications push du navigateur |
| music.swagger.json | Bibliothèque musicale (artistes, albums, titres) |
| photo.swagger.json | Bibliothèque de photos (albums, photos) |
| media_request.swagger.json | Demandes de médias : recherche, envoi, règles ; les réponses de l'administrateur et l'accès aux demandes |
Authentification¶
Les points d'accès prennent Authorization: Bearer <jeton> : un jeton de
session obtenu à la connexion, ou une clé d'API dans la limite de ses
permissions (API du serveur). Accessibles
sans : la connexion et le renouvellement de session, l'inscription par
invitation, Quick Connect, la réinitialisation du mot de passe, l'assistant
d'installation et son état, et les liens de téléchargement publics.