Harici API
Harici API, programların bir HTTP çağrısıyla UMS işlevlerine erişmesini veya bunları tetiklemesini sağlar.
Harici API nasıl etkinleştirilir
UMS.conf dosyasını düzenleyin ve şunun gibi bir api_anahtarı yapılandırın
api_anahtarı = gizli_parola
gizli_parola
en az 12 karakterden oluşmak zorundadır.
API kullanımı
Eğer harici API etkinleştirildiyse, API’ye /api/KOMUT olarak yapılan bir POST çağrısıyla erişilebilir.
Klasör Tarama
rescan
Niyet | Tüm kütüphaneyi yeniden tarar |
---|---|
URI | /api/folderscanner/rescan |
POST BODY | YOK |
POST BODY örnek / açıklama | Bu komutun gövde içeriğine ihtiyacı yoktur |
Şu sürümden beri mevcut | 10.4.2 |
Bu, büyük kütüphaneler için yavaş olabilir
Örnek:
curl -w "%{http_code}\n" -H "api-key: gizli_parola" http://localhost:5001/api/folderscanner/rescan
rescanFileOrFolder
Niyet | Dosya sisteminin kısmi bir alt ağacını yeniden tarar. |
---|---|
URI | /api/folderscanner/rescanFileOrFolder |
POST BODY | TARANACAK_YOL |
POST BODY örnek / açıklama | örnek: "/music/pop/Madonna". Yol, paylaşılan bir yolun kök veya alt klasörü olmak zorundadır. |
Şu sürümden beri mevcut | 10.4.2 |
Örnek:
curl -d "TARANACAK_YOL" -w "%{http_code}\n" -H "api-key: gizli_parola" -X POST http://localhost:5001/api/folderscanner/rescanFileOrFolder
Müzik Beğenme (albümler ve şarkılar)
like song
Şarkı beğenildi olarak işaretlenecektir.
Niyet | musicBrainz trackId ile tanımlanan bir şarkıyı beğenir |
---|---|
URI | <span class="s1">/api/like/likesong</span> |
POST BODY | musicBrainz_trackID |
POST BODY örnek / açıklama | b8695995-45e9-405d-b4aa-e50e8760fe25 |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "b8695995-45e9-405d-b4aa-e50e8760fe25" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/likesong
dislike song
Şarkı beğenilmeyecektir
Niyet | musicBrainz trackId ile tanımlanan bir şarkıyı beğenmez |
---|---|
URI | <span class="s1">/api/like/</span>dislikesong |
POST BODY | musicBrainz_trackID |
POST BODY örnek / açıklama | b8695995-45e9-405d-b4aa-e50e8760fe25 |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "b8695995-45e9-405d-b4aa-e50e8760fe25" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/dislikesong
is song liked
Şarkının beğenilip beğenilmediğini denetleyin.
Niyet | musicBrainz trackId ile tanımlanan şarkının beğenilip beğenilmediğini denetler |
---|---|
URI | <span class="s1">/api/like/</span><span class="s1">issongliked</span> |
POST BODY | musicBrainz_trackID |
POST BODY örnek / açıklama | b8695995-45e9-405d-b4aa-e50e8760fe25 |
RESPONSE BODY | TRUE veya FALSE |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "b8695995-45e9-405d-b4aa-e50e8760fe25" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/issongliked
Bu çağrı, musicbrainz yayım kimliği 1e0eee38-a9f6-49bf-84d0-45d0647799af
ile tanımlanan albümün beğenildi özniteliğini ekler.
like album
Albüm beğenme durumunu true olarak ayarlayın.
Niyet | musicBrainz releaseID ile tanımlanan bir albümü beğenir |
---|---|
URI | <span class="s1">/api/like/</span>likealbum |
POST BODY | musicBrainz_releaseID |
POST BODY örnek / açıklama | 1e0eee38-a9f6-49bf-84d0-45d0647799af |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "1e0eee38-a9f6-49bf-84d0-45d0647799af" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/likealbum
dislike album
Albüm beğenme durumunu kaldırın.
Niyet | musicBrainz releaseID ile tanımlanan bir şarkıyı beğenmez |
---|---|
URI | <span class="s1">/api/like/</span>dislikealbum |
POST BODY | musicBrainz_releaseID |
POST BODY örnek / açıklama | 1e0eee38-a9f6-49bf-84d0-45d0647799af |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "1e0eee38-a9f6-49bf-84d0-45d0647799af" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/dislikealbum
Bu çağrı, musicbrainz yayım kimliği 1e0eee38-a9f6-49bf-84d0-45d0647799af
ile tanımlanan albümün beğenildi özniteliğini kaldırır.
is album liked
Albüm beğenme durumunu denetleyin.
Niyet | musicBrainz releaseID ile tanımlanan albümün beğenilip beğenilmediğini denetler |
---|---|
URI | <span class="s1">/api/like/</span>isalbumliked |
POST BODY | musicBrainz_releaseID |
POST BODY örnek / açıklama | 1e0eee38-a9f6-49bf-84d0-45d0647799af |
RESPONSE BODY | "TRUE" veya "FALSE" |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "1e0eee38-a9f6-49bf-84d0-45d0647799af" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/like/isalbumliked
Bu çağrı, musicbrainz yayım kimliği 1e0eee38-a9f6-49bf-84d0-45d0647799af
ile tanımlanan albümün beğenilip beğenilmediğini denetler.
Derecelendirme
Derecelendirme API’si, şarkıları değerlendirmekten sorumludur. Derecelendirme bilgileri dahili veritabanına (önbellek etkin) ve isteğe bağlı olarak dosyanın kendisine kaydedilir. Eğer UMS.conf içinde audio_update_rating_tag = true
olarak ayarlanırsa, IDv3 derecelendirme alanı da şarkı dosyasında güncellenir (şarkı dosyası biçimi destekleniyorsa).
İçerik dizini sunucusuna göz atarken, MusicBrainzTrackID (varsa) ve audiotrackID, DIDL öğesi içinde desc
üstverisi olarak teslim edilir.
set rating
Niyet | musicBrainz trackId ile tanımlanan bir şarkıda derecelendirmeyi yıldız (0 - 5) olarak ayarlar |
---|---|
URI | <span class="s1">/api/</span><span class="s1">rating/setrating</span> |
POST BODY | musicbrainzTrackId /stars |
POST BODY örnek / açıklama | b8695995-45e9-405d-b4aa-e50e8760fe25/3 |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "b8695995-45e9-405d-b4aa-e50e8760fe25/3" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/rating/setrating
Bu çağrı, musicbrainz parça kimliği b8695995-45e9-405d-b4aa-e50e8760fe25
ile tanımlanan tüm şarkıların kullanıcı derecelendirmesini 3
olarak ayarlar.
get rating
Veritabanından şarkı derecelendirmesini okur
Niyet | musicBrainz trackID ile şarkı derecelendirmesini yıldız (0 - 5) olarak alır. Yanıt gövdesi derecelendirme bilgilerini içerir. |
---|---|
URI | <span class="s1">/api/</span><span class="s1">rating/getrating </span> |
POST BODY | musicbrainzTrackId |
POST BODY örnek / açıklama | b8695995-45e9-405d-b4aa-e50e8760fe25 |
RESPONSE BODY örnek | 3 |
Şu sürümden beri mevcut | 10.20 |
Örnek:
curl -d "b8695995-45e9-405d-b4aa-e50e8760fe25" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/rating/getrating
Bu çağrı, musicbrainz parça kimliği b8695995-45e9-405d-b4aa-e50e8760fe25
ile tanımlanan bir şarkının kullanıcı derecelendirmesini okur.
set rating by audiotrack id
Niyet | UMS dahili audiotrackID ile tanımlanan bir şarkıda derecelendirmeyi yıldız (0 - 5) olarak ayarlar |
---|---|
URI | <span class="s1">/api/</span><span class="s1">rating/setRatingByAudiotrackId </span> |
POST BODY | trackID /stars |
POST BODY örnek / açıklama | 32 |
Şu sürümden beri mevcut | 11.0 |
Örnek:
curl -d "32/3" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/rating/setrating
Bu çağrı, audiotrack kimliği 32
ile tanımlanan şarkıların kullanıcı derecelendirmesini 3
olarak ayarlar.
get rating by audiotrack id
Veritabanından şarkı derecelendirmesini okur
Niyet | UMS dahili audiotrackID ile şarkı derecelendirmesini yıldız (0 - 5) olarak alır. Yanıt gövdesi derecelendirme bilgilerini içerir. |
---|---|
URI | <span class="s1">/api/</span><span class="s1">rating/getRatingByAudiotrackId</span> |
POST BODY | trackId |
POST BODY örnek / açıklama | 32 |
RESPONSE BODY örnek | 3 |
Şu sürümden beri mevcut | 11.0 |
Örnek:
curl -d "32" -w "%{http_code}\n" -H "api-key: secret_password" -X POST http://localhost:5001/api/rating/getRatingByAudiotrackId
Bu çağrı, UMS audiotrack-id 32
ile tanımlanan bir şarkının kullanıcı derecelendirmesini okur.