База знаний · Настройки и аккаунт
API для ИИ-ассистента
Ключи с правами по разделам и что умеет агент
Через API к «Журнал Про» можно подключить ИИ-ассистента, например Claude или своего бота в Telegram. Ассистент сможет рассказать, какие сегодня занятия, найти должников, подготовить сводку по ученику или завершить занятие по вашей просьбе. Ассистент работает с ключом, а у ключа вы сами задаёте права. API есть на тарифах «Профи» и «Эксперт».
Как выпустить ключ
- Откройте Аккаунт → API-ключи.
- В блоке «Новый ключ» введите «Название», например «Claude — отчёты». По нему ключ будет виден в журнале действий.
- В таблице разделов выберите для каждого «нет», «чтение» или «запись». Разделы: «Ученики», «Планы», «Занятия и журнал», «Домашние», «Финансы», «Файлы».
- Выберите «Срок действия»: «Бессрочно», «30 дней» или «До даты…».
- Нажмите «Создать ключ».
Ключ покажется один раз. Нажмите «Скопировать» и сразу передайте его ассистенту. После закрытия посмотреть ключ ещё раз будет нельзя, только выпустить новый.
«Запись» включает чтение. Удалять учеников и оплаты через API нельзя ни с какими правами.
Карточка ключа и отзыв
В блоке «Ключи для агентов» у каждого ключа видны название, начало ключа (crm_…), права, дата создания, когда ключ использовали последний раз, число запросов и срок действия.
Чтобы отключить ключ, нажмите «Отозвать» и подтвердите «Да, отозвать». Ключ перестанет работать сразу. Отозванный ключ и ключ с истёкшим сроком остаются в списке с пометкой «Отозван» или «Истёк».
Что видно в журнале
Каждое изменение через API записывается. Последние изменения показаны прямо на странице, в блоке «Последние изменения через API». Полная история — в журнале действий, фильтр «API-ключи»: когда, каким ключом, что изменено.
Сводки для ассистента
Кроме обычных разделов, в API есть готовые сводки. Они собирают нужное одним запросом, и ассистенту не приходится обходить десяток страниц:
- занятия на сегодня или на несколько дней вперёд с контекстом ученика;
- всё об ученике сразу: карточка, план с текущей темой, последние занятия, открытые задания и баланс;
- должники;
- что ждёт вашего действия: неотмеченные занятия и задания на проверке;
- поиск ученика по имени.
Если у ключа нет прав на какой-то раздел, эта часть сводки приходит пустой.
Документация
Полное описание запросов — по ссылке «Документация API (OpenAPI)» в правом верхнем углу страницы: она открывает /api/docs на сайте сервиса. Ключ передаётся в заголовке Authorization: Bearer ….
Частые вопросы
Ключ не работает: ошибка про тариф.
API есть на «Профи» и «Эксперте». На «Репетиторе» ключ не выпустить и не использовать. Если тариф закончился, включается режим «только просмотр»: ключи могут только читать. Проверьте тариф в Тариф и оплата.
Ключ потерялся. Где его посмотреть?
Нигде — ключ показывается один раз. Отзовите старый и создайте новый.
Видит ли ассистент данные других учителей?
Нет. Ключ работает только с вашими данными и только в тех разделах, которые вы разрешили.