API Яндекс.Диск (PHP) #2: Получение информации о файлах и директориях

В новом уроке мы с вами пропишем методы для получения информации о файлах и директориях находящихся на Яндекс.Диск.

Получение директорий с Яндекс.Диска через API

Для получения информации из области РЕСУРСОВ нужно отправить запрос на URL

https://cloud-api.yandex.net/v1/disk/resources

Для получения информации из области КОРЗИНЫ нужно отправить запрос на URL

https://cloud-api.yandex.net/v1/disk/trash/resources

В качестве параметров вы можете передать следующие данные.

Метод для получения директорий принимает 2 аргумента: массив с параметрами для запроса и тип директории (активные ресурсы или корзина).

/**
 * Получение директорий
 *
 * @param array $arrParams параметры для получения ресурсов
 * @param string $typeDir тип области ресурсов
 *
 * @return array
 */
public function disk_resources(array $arrParams, string $typeDir = ''): array
{
    switch ($typeDir) {
        case 'trash':
            /* запрос для директорий в корзине */
            $urlQuery = 'https://cloud-api.yandex.net/v1/disk/trash/resources';
            break;

        case 'standart':
            /* запрос для активных директорий */
            $urlQuery = 'https://cloud-api.yandex.net/v1/disk/resources';
            break;
    }

    return $this->sendQueryYaDisk($urlQuery, $arrParams);
}

Пример отправки запроса

...
$backupClass = new Backup();

$arrQuery = [
    'path' => '/',
    'fields' => '_embedded.items.name,_embedded.items.type',
    'limit' => 100,
    'offset' => 0,
    'preview_crop' => '',
    'preview_size' => '',
    'sort' => ''
];
$backupClass->disk_resources($arrQuery);

Пример ответа

{
  "public_key": "HQsmHLoeyBlJf8Eu1jlmzuU+ZaLkjPkgcvmokRUCIo8=",
  "_embedded": {
    "sort": "",
    "path": "disk:/foo",
    "items": [
      {
        "path": "disk:/foo/bar",
        "type": "dir",
        "name": "bar",
        "modified": "2014-04-22T10:32:49+04:00",
        "created": "2014-04-22T10:32:49+04:00"
      },
      {
        "name": "photo.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-21T14:57:13+04:00",
        "modified": "2014-04-21T14:57:14+04:00",
        "path": "disk:/foo/photo.png",
        "md5": "4334dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 34567
      }
    ],
    "limit": 20,
    "offset": 0
  },
  "name": "foo",
  "created": "2014-04-21T14:54:42+04:00",
  "custom_properties": {"foo":"1", "bar":"2"},
  "public_url": "https://yadi.sk/d/2AEJCiNTZGiYX",
  "modified": "2014-04-22T10:32:49+04:00",
  "path": "disk:/foo",
  "type": "dir"
}

Данные получаемые в ответе:

Получение сплошного списка файлов и директорий с Яндекс.Диска

Для получение всех файлов и директорий, без учёта структуры директорий, используют метод resources/files.

Данный API метод принимает следующие параметры:

Отправляем запрос на получение списка файлов и директорий.

/**
 * Получение плоского списка всех файлов
 *
 * @param array $arrParams параметры для получения ресурсов
 *
 * @return array
 */
public function disk_resources_files(array $arrParams = []): array
{
    $urlQuery = 'https://cloud-api.yandex.net/v1/disk/resources/files';
    return $this->sendQueryYaDisk($urlQuery, $arrParams);
}

Пример ответа:

{
  "items": [
      {
        "name": "photo2.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-22T14:57:13+04:00",
        "modified": "2014-04-22T14:57:14+04:00",
        "path": "disk:/foo/photo2.png",
        "md5": "53f4dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 54321
      },
      {
        "name": "photo1.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-21T14:57:13+04:00",
        "modified": "2014-04-21T14:57:14+04:00",
        "path": "disk:/foo/photo1.png",
        "md5": "4334dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 34567
      }
    ],
    "limit": 20,
    "offset": 0
  }

Описание элементов ответа:

Получение последних добавленных файлов и директорий

Для получения последних добавленных ресурсов используется метод resources/last-uploaded. Данный метод использует те же параметры, что и resources/files.

/**
 * Получение последних загруженных элементов
 *
 * @param array $arrParams параметры для получения ресурсов
 *
 * @return array
 */
public function disk_resources_last_uploaded(array $arrParams = []): array
{
    $urlQuery = 'https://cloud-api.yandex.net/v1/disk/resources/last-uploaded';
    return $this->sendQueryYaDisk($urlQuery, $arrParams);
}

Таким образом мы с вами научились запрашивать информацию о имеющихся файлах и директориях на Яндекс.Диске.

В следующем уроке я вам покажу как загружать и скачивать файлы с Яндекс.Диска.