Yandex music api php

Документация библиотеки#

⚠️ Это неофициальная библиотека. Сообщество разработчиков общаются и помогают друг другу в Telegram чате, присоединяйтесь!

Содержание#

• Введение
  1. Доступ к вашим данным Яндекс.Музыка
• Установка
• Начало работы
  1. Изучение по примерам
  2. Особенности использования асинхронного клиента
  3. Логирование
  4. Документация
• Получение помощи
• Список изменений
• Реализации на других языках
  1. C#
  2. PHP
  3. JavaScript
• Разработанные проекты
  1. Плагин для Kodi
  2. Telegram бот-клиент
• Благодарность
• Внесение своего вклада в проект
• Спонсоры
• Лицензия

Введение#

Эта библиотека предоставляется Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки.

Она совместима с версиями Python 3.7+ и поддерживает работу как с синхронном, так и асинхронным (asyncio) кодом.

В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток объектов высокого уровня дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки(reverse engineering) API.

Доступ к вашим данным Яндекс.Музыка#

Начиная с версии 2.0.0 библиотека больше не предоставляет интерфейсы для работы с OAuth Яндекс и Яндекс.Паспорт. Задача по получению токена для доступа к данным на плечах разработчиков использующих данную библиотеку. О том как получить токен читайте в документации.

Установка#

Вы можете установить или обновить Yandex Music API при помощи:

pip install -U yandex-music

Или Вы можете установить из исходного кода с помощью:

git clone https://github.com/MarshalX/yandex-music-api cd yandex-music-api python setup.py install

Начало работы#

Приступив к работе первым делом необходимо создать экземпляр клиента.

Инициализация синхронного клиента:

from yandex_music import Client client = Client() client.init() # или client = Client().init() 

Инициализация асинхронного клиента:

from yandex_music import ClientAsync client = ClientAsync() await client.init() # или client = await Client().init() 

Вызов init() необходим для получение информации для упрощения будущих запросов.

Работа без авторизации ограничена. Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла. Для понимания всех ограничений зайдите на сайт Яндекс.Музыка под инкогнито и воспользуйтесь сервисом.

Для доступа к своим личным данным следует авторизоваться. Это осуществляется через токен аккаунта Яндекс.Музыка.

from yandex_music import Client client = Client('token').init() 

После успешного создания клиента Вы вольны в выборе необходимого метода из API. Все они доступны у объекта класса Client . Подробнее в методах клиента в документации.

Пример получения первого трека из плейлиста “Мне нравится” и его загрузка:

from yandex_music import Client client = Client('token').init() client.users_likes_tracks()[0].fetch_track().download('example.mp3') 

В примере выше клиент получает список треков которые были отмечены как понравившиеся. API возвращает объект TracksList в котором содержится список с треками класса TrackShort. Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу fetch_track() . Затем можно скачать трек методом download() .

Пример получения треков по ID:

from yandex_music import Client client = Client().init() client.tracks(['10994777:1193829', '40133452:5206873', '48966383:6693286', '51385674:7163467']) 

В качестве ID трека выступает его уникальный номер и номер альбома. Первым треком из примера является следующий трек:music.yandex.ru/album/1193829/track/10994777

Выполнение запросов с использование прокси в синхронной версии:

from yandex_music.utils.request import Request from yandex_music import Client request = Request(proxy_url='socks5://user:password@host:port') client = Client(request=request).init() 

Выполнение запросов с использование прокси в асинхронной версии:

from yandex_music.utils.request_async import Request from yandex_music import ClientAsync request = Request(proxy_url='http://user:pass@some.proxy.com') client = await ClientAsync(request=request).init() 

Socks прокси не поддерживаются в асинхронной версии.

Изучение по примерам#

Вот несколько примеров для обзора. Даже если это не Ваш подход к обучению, пожалуйста, возьмите и бегло просмотрите их.

Код примеров опубликован в открытом доступе, поэтому Вы можете взять его и начать писать вокруг своё.

Посетите эту страницу, чтобы изучить официальные примеры.

Особенности использования асинхронного клиента#

При работе с асинхронной версией библиотеке стоит всегда помнить следующие особенности:

• Клиент следует импортировать с названием ClientAsync , а не просто Client .
• При использовании методов-сокращений нужно выбирать метод с суффиксом _async .

Пояснение ко второму пункту:

from yandex_music import ClientAsync client = await ClientAsync('token').init() liked_short_track = (await client.users_likes_tracks())[0] # правильно full_track = await liked_short_track.fetch_track_async() await full_track.download_async() # НЕПРАВИЛЬНО full_track = await liked_short_track.fetch_track() await full_track.download() 

Логирование#

Данная библиотека использует logging модуль. Чтобы настроить логирование на стандартный вывод, поместите

import logging logging.basicConfig( level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s' ) 

Вы также можете использовать логирование в вашем приложении, вызвав logging.getLogger() и установить уровень какой Вы хотите:

logger = logging.getLogger() logger.setLevel(logging.INFO) 

Если Вы хотите DEBUG логирование:

logger.setLevel(logging.DEBUG) 

Документация#

Документация yandex-music-api расположена на readthedocs.io. Вашей отправной точкой должен быть класс Client , а точнее его методы. Именно они выполняют все запросы на API и возвращают Вам готовые объекты. Класс Client на readthedocs.io.

Получение помощи#

Получить помощь можно несколькими путями:

• Задать вопрос в Telegram чате, где мы помогаем друг другу, присоединяйтесь!
• Сообщить о баге можно создав discussion.
• Найти ответ на вопрос в документации библиотеки.

Список изменений#

Весь список изменений ведётся в файле CHANGES.md.

Реализации на других языках#

C##

Реализация с совершенно другим подходом, так как используется API для frontend’a, а не мобильных и десктопных приложений: Winster332/Yandex.Music.Api.

@Winster332 не сильно проявляет активность, но существует форк, который продолжил начатое. Эндпоинты изменены с фронтовых на мобильные: K1llMan/Yandex.Music.Api.

PHP#

Частично переписанная текущая библиотека на PHP: LuckyWins/yandex-music-api.

JavaScript#

API wrapper на Node.JS. Не обновлялся больше двух лет: itsmepetrov/yandex-music-api. Продолжение разработки заброшенной библиотеки: kontsevoye/ym-api.

Разработанные проекты#

Плагин для Kodi#

Плагин может проигрывать пользовательские плейлисты и плейлисты Яндекса, поиск по Яндекс Музыке, радио.

Telegram бот-клиент#

Неофициальный бот. Умные и ваши плейлисты, понравившиеся треки. Лайки, дизлайки, текста песен, поиск, распознавание песен, похожие треки! Полноценный клиент на базе мессенджера.

Статья на habr.com с описанием реализации: Под капотом бота-клиента Яндекс.Музыки.

Благодарность#

Спасибо разработчикам python-telegram-bot . Выбрал Вас в качестве примера.

Внесение своего вклада в проект#

Внесение своего вклада максимально приветствуется! Есть перечень пунктов, который стоит соблюдать. Каждый пункт перечня расписан в CONTRIBUTING.md.

Вы можете помочь и сообщив о новом поле пришедшем от API.

Спонсоры#

JetBrains#

JetBrains предоставляет бесплатный набор инструментов для разработки активным контрибьюторам некоммерческих проектов с открытым исходным кодом.

Лицензия#

Вы можете копировать, распространять и модифицировать программное обеспечение при условии, что модификации описаны и лицензированы бесплатно в соответствии с LGPL-3. Произведения производных (включая модификации или что-либо статически связанное с библиотекой) могут распространяться только в соответствии с LGPL-3, но приложения, которые используют библиотеку, необязательно.

• Беглый обзор
  • Yandex Music API
  • yandex_music.client
  • yandex_music.client_async
  • Получение чарта
  • Обновление стрика дейлика
  • Получение альбома с треками
  • Лайки и дизлайки сущностей
  • Текст текущего играющего трека
  • Использование прокси
  • Работа с поиском
  • yandex_music
  • Версия 2.1.0
  • Версия 2.0.0
  • Версия 1.0.0
  • Версия 0.1.1
  • Версия 0.0.16
  • Версия 0.0.15
  • Версия 0.0.14
  • Pull Requests
  • Тесты
  • Документация
  • Форматирование кода (стиль написания)
  • Создание новых моделей
  • Makefile
  • Обязательства
  • Стандарты
  • Обязанности
  • Область применения
  • Претензии
  • Атрибуция
  • Поддерживаемые версии
  • Сообщение об уязвимости

  Источник

  Saved searches

  Use saved searches to filter your results more quickly

  You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

  Unofficial PHP library for working with the Yandex.Music API

  License

  StounhandJ/yandex-music-api

  This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

  Name already in use

  A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

  Sign In Required

  Please sign in to use Codespaces.

  Launching GitHub Desktop

  If nothing happens, download GitHub Desktop and try again.

  Launching GitHub Desktop

  If nothing happens, download GitHub Desktop and try again.

  Launching Xcode

  If nothing happens, download Xcode and try again.

  Launching Visual Studio Code

  Your codespace will open once ready.

  There was a problem preparing your codespace, please try again.

  Latest commit

  Git stats

  Files

  Failed to load latest commit information.

  README.md

  Not an official package for working with the Yandex API.

  $ composer require stounhandj/yandex-music-api 

  < "require": < "stounhandj/yandex-music-api": "^0.5.2" > >

  use StounhandJ\YandexMusicApi\Client; $token pl-s">AQAAAAANDd5rMAG1XnIKIEVVMGV4ibf8kw3FeA1"; $client = new Client($token); foreach ($client->getLikesTracks() as $track)< echo $track->title; >

  Example of downloading the first track from the album you like

  use StounhandJ\YandexMusicApi\Client; $token pl-s">AQAAAAANDd5rMAG1XnIKIEVVMGV4ibf8kw3FeA1"; $client = new Client($token); $likesAlbum = $client->getLikesAlbums()[0]; $firstTrack = $likesAlbum->getTracks()[0]; $result = $firstTrack->downloadTrack("test.mp3");

  About

  Unofficial PHP library for working with the Yandex.Music API

  Источник

  Saved searches

  Use saved searches to filter your results more quickly

  You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

  sonrac/yandex-music-api

  This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

  Name already in use

  A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

  Sign In Required

  Please sign in to use Codespaces.

  Launching GitHub Desktop

  If nothing happens, download GitHub Desktop and try again.

  Launching GitHub Desktop

  If nothing happens, download GitHub Desktop and try again.

  Launching Xcode

  If nothing happens, download Xcode and try again.

  Launching Visual Studio Code

  Your codespace will open once ready.

  There was a problem preparing your codespace, please try again.

  Latest commit

  Git stats

  Files

  Failed to load latest commit information.

  README.MD

  Unofficial Music Yandex Api PHP Wrapper

  composer require sonrac/yandex-music-api

  or add to your composer.json to require section

  use sonrac\YandexMusic\Yandex; $api = new Yandex('username', 'password');

  use sonrac\YandexMusic\Yandex; $api = new Yandex('username', 'password', true);

  $accountStatus = $api->getAccountStatus();

  $searchResult = $api->search('text', 0);

  // For current user $playLists = $api->getUserPlayLists(); // For some user with uid 1000 $playLists = $api->getUserPlayLists(1000); * Get play list ```php $playlist = $api->getPlayList(100);

  $playlists = $api->getPlayLists([1003, 1010]);

  $playlists = $api->getPlayLists([1003, 1010]);

  $resultRemove = $api->removePlaylist(1003);

  $resultRename = $api->renamePlaylist(1003, 'new playlist');

  $resultRename = $api->addTrackToPlaylist(1003, [1,2,3,4]);

  $resultRename = $api->removeTracksFromPlaylist(1003, [1,2,3,4]);

  Источник