---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/dev/on-premises/disk-api/doc/ru/concepts/quickstart.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/on-premises/disk-api/doc/ru/llms.txt

# Доступ к API

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

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

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

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

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

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

- Хост для всех запросов к API — `cloud-api.<ваш_домен>`. При [загрузке](https://yandex.ru/dev/on-premises/disk-api/doc/ru/reference/upload.md) и [скачивании](https://yandex.ru/dev/on-premises/disk-api/doc/ru/reference/content.md) файла необходимо отдельно обращаться к сервису загрузки файлов и хранилищу Диска.

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

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

## Получение OAuth-токенов {#oauth}

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



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

1. Обратитесь к администратору вашего решения on-premises. Попросите его выдать вам идентификатор приложения (client ID). Он может скопировать его из значения **APIGW360_CLIENT_ID**, полученного на этапе пост-инициализации. [Как администратор может получить client ID](https://yandex.ru/support/yandex-360/business/on-premises/deployment/ru/after-install/create-organization#get-scim-oauth-token)


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

    1. Перейдите по ссылке

        ```html
        https://passport.<ваш_домен>/oauth/authorize?response_type=token&client_id=<ClientID>
        ```

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

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

    1. Скопируйте значение токена из адресной строки браузера и сохраните его.

        ![OAuth-токен](../_images/on-prem-token.png =900x)

        {% note info "Вы не сможете найти полученный токен в личном кабинете" %}

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

        {% endnote %}

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

    ```yaml
    Authorization: OAuth 0c4181a7c2cf4521964a72ff57a34a07
    ```