Публикация файла или папки

Файлы и папки на Диске можно публиковать — генерировать ссылки, по которым они будут доступны не только владельцу. Доступ к уже опубликованному ресурсу можно закрыть.

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

  • public_key — ключ опубликованного ресурса. По этому ключу другие приложения смогут получить метаданные опубликованного ресурса.
  • public_url — публичная ссылка на ресурс вида https://yadi.sk/.... Пользователи, которым владелец ресурса передаст эту ссылку, смогут открыть опубликованную папку или скачать файл.

Когда владелец закрывает доступ к ресурсу, эти атрибуты удаляются.

Публикация ресурса

Ресурс становится доступен по прямой ссылке. Опубликовать ресурс можно только с OAuth-токеном владельца файла.

Формат запроса

Запрос публикации следует отправлять с помощью метода PUT.

https://cloud-api.yandex.net/v1/disk/resources/publish
 ? path=<путь к публикуемому ресурсу>
Query-параметры
path *

Путь к публикуемому ресурсу. Например, %2Fbar%2Fphoto.png

Путь в значении параметра следует кодировать в URL-формате.

*  Обязательный параметр

Формат ответа

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает ссылку на мета-информацию об опубликованном ресурсе в теле ответа (в объекте Link).

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

{
  "href": "https://cloud-api.yandex.net/v1/disk/resources?path=disk%3A%2Fbar%2Fphoto.png",
  "method": "GET",
  "templated": false
}
Описание элементов ответа
ЭлементОписание
href

URL. Может быть шаблонизирован, см. ключ templated.

method

HTTP-метод для запроса URL из ключа href.

templated

Признак URL, который был шаблонизирован согласно RFC 6570. Возможные значения:

  • «true» — URL шаблонизирован: прежде чем отправлять запрос на этот адрес, следует указать нужные значения параметров вместо значений в фигурных скобках.
  • «false» — URL может быть запрошен без изменений.

Закрытие доступа к ресурсу

Ресурс теряет атрибуты public_key и public_url, публичные ссылки на него перестают работать. Закрыть доступ к ресурсу можно только с OAuth-токеном владельца ресурса.

Формат запроса

Закрывать доступ к ресурсу следует с помощью метода PUT.

https://cloud-api.yandex.net/v1/disk/resources/unpublish
 ? path=<путь к закрываемому ресурсу>
Query-параметры
path *

Путь к закрываемому ресурсу. Например, %2Fbar%2Fphoto.png

Путь в значении параметра следует кодировать в URL-формате.

*  Обязательный параметр

Формат ответа

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает ссылку на мета-информацию о закрытом ресурсе в теле ответа (в объекте Link).

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

{
  "href": "https://cloud-api.yandex.net/v1/disk/resources?path=disk%3A%2Fbar%2Fphoto.png",
  "method": "GET",
  "templated": false
}
Описание элементов ответа
ЭлементОписание
href

URL. Может быть шаблонизирован, см. ключ templated.

method

HTTP-метод для запроса URL из ключа href.

templated

Признак URL, который был шаблонизирован согласно RFC 6570. Возможные значения:

  • «true» — URL шаблонизирован: прежде чем отправлять запрос на этот адрес, следует указать нужные значения параметров вместо значений в фигурных скобках.
  • «false» — URL может быть запрошен без изменений.