Авторизация

REST API V2 использует OAuth 2.0 Client Credentials. Такой доступ предназначен для взаимодействия серверов и не требует входа пользователя в AXKED.

Получение доступа

1. Войдите в AXKED под директором нужной компании.
2. Откройте Настройки → Общие → Доступ к REST API.
3. Нажмите значок + «Добавить доступ» рядом с названием раздела. В открывшемся окне заполните Название подключения, например «Сайт школы».
4. Выберите нужные разрешения и нажмите Создать подключение.
5. Сохраните показанные Client ID и Client Secret на сервере интеграции. Секрет показывается один раз.

Для чтения филиалов, групп и расписания достаточно первоначально выбранных branches:read, groups:read и schedule:read. Для учёта оплат дополнительно выберите students:search, payments:read и payments:write. Цены групп и сведения о преподавателях включаются отдельно.

Галочки Всё чтение, Вся запись и Выбрать всё выбирают доступные разрешения в этой форме; перед сохранением можно снять отдельные галочки. Новые разрешения, появившиеся позднее, сами не включатся.

Название подключения служит для вашего удобства и не ограничивает запросы доменом сайта. Не передавайте секрет в код браузера, мобильного приложения или формы на сайте. Для проверки на учебных данных используйте отдельную тестовую компанию и подключение этой компании: новое подключение к рабочей компании обращается к её настоящим данным.

Получение токена

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
client_id=CLIENT_ID
client_secret=CLIENT_SECRET
scope=branches:read groups:read schedule:read

В ответе возвращаются access_token, token_type и срок действия expires_in.

Используйте адрес того же экземпляра AXKED, где создано подключение. В примере запрашиваются только три права чтения. Для оплаты укажите в scope также выданные этому подключению students:search payments:read payments:write, разделяя права пробелами. После истечения срока токена получите новый тем же запросом.

Использование токена

Authorization: Bearer ACCESS_TOKEN
Accept: application/json

Каждый OAuth-клиент связан с одной компанией и видит только её данные.

Разрешения

Запрашивайте только права, выданные этому подключению. Права, не выбранные директором, в токен не включаются.

• branches:read - филиалы;
• groups:read - каталог групп;
• schedule:read - расписание, в том числе в каталоге групп;
• groups:prices:read - цены в каталоге групп;
• groups:teachers:read - сведения о преподавателях в каталоге групп.
• students:read - карточки учеников, контакты и история участия в группах;
• finance:read - финансовые операции всей компании;
• balances:read - текущие балансы и история начислений/списаний;
• subscriptions:read - купленные абонементы и пакеты;
• students:search - поиск ID ученика по контактам;
• payments:read - параметры учёта и проверка оплат сайта;
• payments:write - учёт уже полученных сайтом оплат.

Для цен и сведений о преподавателях также требуется groups:read. Пустой список разрешений не даёт доступа к данным. Новые разрешения автоматически не добавляются.

Изменение и отключение доступа

В блоке Выданные доступы найдите подключение, измените галочки и нажмите Сохранить. Снятое право перестаёт разрешать запросы; для работы с добавленными правами получите токен с новым списком scope.

Кнопка Перевыпустить секрет показывает новый секрет и отключает прежний секрет и выданные токены. Обновите секрет на сервере сайта и получите новый токен. Кнопка Отозвать доступ отключает подключение полностью. Для замены секрета существующего сайта используйте перевыпуск в его подключении, чтобы сохранить связь с ранее переданными оплатами.

Связанные инструкции

Формат запросов и ответов · Поиск ученика для оплаты · Оплаты внешнего сайта · Приём заявок с сайта и вебхуки