> ## Documentation Index
> Fetch the complete documentation index at: https://docs.exode.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Права API-ключа

> Какие галочки включить у API-ключа в кабинете, чтобы работали нужные методы SaaS API

У каждого API-ключа есть набор прав — это галочки на странице ключа в кабинете. Методы SaaS API проверяют эти
права: если нужной галочки нет, API вернёт `401` с `cause: "Forbidden"` и сообщением
`Forbidden seller resource - permissions <Код>`. Ниже перечислены только те права, которые реально
проверяют методы SaaS API. Остальные галочки на странице ключа на работу API не влияют.

## Где включить права

<Steps>
  <Step title="Откройте страницу ключей">
    **Управление → Школа → Для разработчиков → API-ключи** (`/manage/school/api-keys`).
  </Step>

  <Step title="Откройте настройки ключа">
    В строке нужного ключа выберите **«Редактировать»**.
  </Step>

  <Step title="Отметьте галочки и сохраните">
    Галочки сгруппированы по разделам: «Управление школой», «Управление курсами» и т.д. Нажмите
    **«Сохранить»**.
  </Step>
</Steps>

<Info>
  Если у метода указано несколько прав, достаточно **любого одного** из них.
</Info>

<Warning>
  Выгрузки проверяют права не при запуске, а во время сборки файла: без нужного права
  `query-export/generate` всё равно ответит `201`, а выгрузка завершится со `status: Failed`.
</Warning>

## Права по задачам

Выберите, что должна делать интеграция, и включите соответствующие галочки.

| Задача интеграции | Что включить в кабинете |
| - | - |
| Создавать, обновлять, искать и удалять пользователей | «Управление пользователями школы» |
| Читать и записывать состояния пользователя, выдавать токен входа | «Управление пользователями школы» |
| Читать группы, добавлять участников в группы и убирать из них | «Управление пользователями школы» |
| Читать курсы и прогресс учеников | «Управление пользователями школы» **или** «Куратор курсов» |
| Читать доступы к продуктам | «Управление пользователями школы» **или** «Управление студентами курса» |
| Читать сертификаты | «Управление курсами» **или** «Управление студентами курса» |
| Работать с макетами форм и дополнительными полями | «Управление формами» |
| Читать счета | «Продажи школы» |
| Читать оргструктуру: отделы, должности, сотрудников, отсутствия | «Просмотр персонала» |
| Изменять оргструктуру (синхронизация из HR/1С) | «Управление персоналом» |
| Выгружать отчёты | Право на выгружаемые данные — см. [таблицу по типам отчётов](/ru/exode-api/school/query-export/generate#требования-к-правам-доступа) |

## Справочник прав

В тексте ошибки API называет право техническим кодом, например
`Forbidden seller resource - permissions FormManage`. По коду в правой колонке найдите, какую галочку включить.

### Управление школой

| Галочка в кабинете | Методы | Код в API |
| - | - | - |
| Управление пользователями школы | [Пользователи](/ru/exode-api/school/user/create): создание, обновление, upsert, поиск, список, удаление, [состояния](/ru/exode-api/school/user/state), [токен входа](/ru/exode-api/school/user/session/auth-token). [Группы](/ru/exode-api/school/group/list) и [участники групп](/ru/exode-api/school/group-member/list). [Курсы](/ru/exode-api/school/course/list) и [прогресс](/ru/exode-api/school/course/progresses). [Доступы к продуктам](/ru/exode-api/school/product-access/list). [Выгрузки](/ru/exode-api/school/query-export/generate) пользователей, учеников, участников групп и доступов | `SchoolManageUsers` |

### Управление курсами

| Галочка в кабинете | Методы | Код в API |
| - | - | - |
| Куратор курсов | [Курсы](/ru/exode-api/school/course/list), [получение курса](/ru/exode-api/school/course/get) и [прогресс](/ru/exode-api/school/course/progresses). Выгрузки участников групп и попыток практик | `CourseCurator` |
| Управление студентами курса | [Доступы к продуктам](/ru/exode-api/school/product-access/list), [сертификаты](/ru/exode-api/school/certificate/list). Выгрузки учеников и доступов | `CourseStudentManage` |
| Управление курсами | [Создание курса](/ru/exode-api/school/course/create) (в том числе с модулями, уроками и блоками), [изменение](/ru/exode-api/school/course/update) и [получение курса](/ru/exode-api/school/course/get). [Сертификаты](/ru/exode-api/school/certificate/list). Выгрузки участников групп и попыток практик | `CourseManage` |

### Управление формами

| Галочка в кабинете | Методы | Код в API |
| - | - | - |
| Управление формами | [Макеты форм](/ru/exode-api/school/form-layout/list): список, создание, обновление, удаление. [Дополнительные поля](/ru/exode-api/school/custom-field/get): чтение и запись значений | `FormManage` |

### Управление организацией

| Галочка в кабинете | Методы | Код в API |
| - | - | - |
| Продажи школы | [Счета](/ru/exode-api/school/invoice/list), выгрузка счетов | `SellerSales` |

### Управление персоналом

Раздел есть только у корпоративных школ.

| Галочка в кабинете | Методы | Код в API |
| - | - | - |
| Просмотр персонала | Чтение: [отделы](/ru/exode-api/school/staff/department), [должности](/ru/exode-api/school/staff/position), [трудоустройства](/ru/exode-api/school/staff/employment), [отсутствия](/ru/exode-api/school/staff/absence) | `StaffView` |
| Управление персоналом | Создание, изменение и удаление отделов, должностей, трудоустройств, [руководителей отделов](/ru/exode-api/school/staff/department-manager) и отсутствий | `StaffManage` |

## Права по умолчанию

Новый ключ сразу получает все права, которые нужны методам SaaS API в его типе школы:

* **в любой школе** — «Управление пользователями школы», «Управление формами», «Куратор курсов», «Управление
  студентами курса», «Управление курсами» и другие права разделов «Управление школой» и «Управление курсами»;
* **в коммерческой школе** — дополнительно «Продажи школы» и «Возвраты школы»;
* **в корпоративной школе** — дополнительно «Управление персоналом» и «Просмотр персонала».

Поэтому свежий ключ работает со всеми методами без настройки. Галочки стоит менять, если нужно **ограничить**
интеграцию: например, ключу для синхронизации сотрудников оставить только права раздела «Управление персоналом».
Если после такой настройки метод вернул `401` `Forbidden seller resource - permissions <Код>`, найдите в таблицах выше, какая галочка ему нужна.

## Отличия в корпоративных школах

В корпоративных школах часть галочек подписана иначе: «Управление пользователями компании» вместо
«Управление пользователями школы». Код права при этом тот же. Галочки «Продажи школы» и «Возвраты школы» в
корпоративных школах не показываются.

## Системные права

Сервисному пользователю ключа автоматически выдаётся системный признак API-клиента (`UserIsApiClient`) — без
него SaaS-методы не работают. В кабинете он не отображается и настраивать его не нужно. Если на запрос с
корректным токеном приходит ошибка доступа при всех нужных галочках, напишите в
[поддержку](https://t.me/exode_support_biz).

***

*Обновлено: 2026-09-28 05:04 UTC*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.