Доступ к API

Для успешного вызова API необходимы:

  • Корректные заголовки Accept и Content-Type: API Диска поддерживает только один MIME-тип, application/json. Любое другое значение приведет к ошибке формата данных.

  • URL, составленный согласно требованиям к нужному запросу.

  • OAuth-токен, выданный вашему приложению для доступа к Диску определенного пользователя. Для запросов, которые не требуют авторизации, это указано явно.

Общие правила для составления URL

Правила, общие для всех ресурсов:

  • Хост для всех запросов к API — cloud-api.yandex.net. При загрузке и скачивании файла необходимо отдельно обращаться к сервису загрузки файлов и хранилищу Диска.

  • В каждом запросе необходимо указывать версию API, например, версия 1 обозначается так: cloud-api.yandex.net/v1/.

  • Корневой каталог Диска может быть указан как явно, так и неявно – пути disk:/foo и /foo указывают на одну и ту же папку.

Получение OAuth-токенов

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

Чтобы использовать протокол OAuth при работе с Яндекс Диском:

  1. Создайте свое OAuth-приложение по инструкции из Справки OAuth Яндекс ID. В разделе Доступ к данным укажите необходимые права доступа из тех, которые используются в API Яндекс Диска (помимо доступа к файлам пользователя можно пользоваться папкой приложения). Начните вводить название доступа и выберите нужное значение в выпадающем списке:

    • Запись в любом месте на Диске — cloud_api:disk.write;
    • Чтение всего Диска — cloud_api:disk.read;
    • Доступ к папке приложения на Диске — cloud_api:disk.app_folder;
    • Доступ к информации о Диске — cloud_api:disk.info.

  2. На странице приложения скопируйте идентификатор приложения из поля ClientID — он потребуется для получения OAuth-токена. В дальнейшем открыть страницу со всеми вашими приложениями вы сможете по ссылке oauth.yandex.ru.

  3. Получите OAuth-токен:

    1. Перейдите по ссылке
    https://oauth.yandex.ru/authorize?response_type=token&client_id=<ClientID>

    Вместо <ClientID> подставьте значение идентификатора приложения.

    1. Если токен вашему приложению выдается впервые или срок жизни предыдущего токена истек, откроется экран авторизации. Войдите в сервис.

    2. Скопируйте значение токена с открывшейся страницы и сохраните его.

      Вы не сможете найти полученный токен в личном кабинете

      Сервис Яндекс OAuth не хранит выдаваемые токены в публичном доступе. Если вы не сохранили токен, вы можете получить его еще раз.

    Полученный токен следует передавать в заголовке Authorization при каждом вызове API Диска, указывая тип токена перед его значением. Пример такого заголовка:

    Authorization: OAuth 0c4181a7c2cf4521964a72ff57a34a07

Полную информацию об OAuth-авторизации и токенах читайте в документации OAuth-сервиса Яндекса.

Предыдущая
Яндекс Диск — REST API
Следующая
Папки приложений