API-ключи
Раздел «API-ключи» позволяет подключать внешние программы — бухгалтерские системы, CRM, аналитику, самописные скрипты — к данным вашего автосервиса, чтобы они могли читать информацию автоматически. Ключ — это длинный секретный пароль для программы: выдаётся один раз при создании, потом его уже не посмотреть, только создать новый. Все ключи работают только на чтение — изменить данные через них нельзя.
Как открыть
В приложении нажмите «Ещё» (крайняя правая иконка в нижней панели) → пункт «API-ключи».
Раздел доступен только на тарифе PRO. Если тариф бесплатный, при нажатии появится окно с предложением перейти на PRO.
Что на экране
Экран состоит из двух частей:
Информационная плашка вверху — серый блок с коротким пояснением: «API-ключи — для подключения внешних систем к вашим данным (только чтение). Ключ показывается один раз при создании; храните его надёжно.»
Список ключей — все созданные ключи вашего сервиса, отсортированные по дате создания (новые сверху). Каждая строка показывает:
- Название ключа — то имя, которое вы придумали при создании (например, «1С Бухгалтерия», «Мой скрипт»). Если ключ отозван, название зачёркнуто и отображается серым.
- Права — перечень разделов, к которым ключ имеет доступ (через запятую), например:
customers:read, invoices:read. - Справа — либо кнопка «Отозвать» (красная), либо метка «отозван» (если ключ уже заблокирован).
Если ключей ещё нет — по центру экрана написано: «Ключей пока нет».
Кнопка «Создать ключ» — плавающая кнопка в правом нижнем углу с иконкой «+».
Каждая кнопка и действие
| Элемент | Где | Что делает | Кому доступно |
|---|---|---|---|
| Пункт «API-ключи» в разделе «Ещё» | Нижняя навигация → «Ещё» | Открывает экран API-ключей. Если нет PRO — показывает окно с предложением подключить тариф | Владелец (owner), Управляющий (manager); другие роли не видят этот пункт |
| Кнопка «Создать ключ» (плавающая, правый нижний угол) | Главный экран API-ключей | Открывает диалог создания нового ключа | Владелец (owner), Управляющий (manager) |
| Кнопка «Отозвать» (красная, напротив каждого ключа) | Строка активного ключа в списке | Немедленно блокирует ключ — программа, использующая его, потеряет доступ. Отозвать можно только активный ключ | Владелец (owner), Управляющий (manager) |
| Метка «отозван» | Строка отозванного ключа | Не кнопка — просто показывает, что ключ заблокирован и больше не работает | — |
| Поле «Название» (в диалоге создания) | Диалог «Создать ключ» | Ввод имени ключа: по нему вы потом поймёте, для какой программы выдан. Не должно быть пустым — без названия кнопка «Создать ключ» в диалоге не сработает | Владелец (owner), Управляющий (manager) |
Галочка customers:read | Диалог «Создать ключ», раздел «Права (read-only):» | Разрешает внешней программе читать список клиентов | Владелец (owner), Управляющий (manager) |
Галочка vehicles:read | Диалог «Создать ключ», раздел «Права (read-only):» | Разрешает читать автомобили | Владелец (owner), Управляющий (manager) |
Галочка appointments:read | Диалог «Создать ключ», раздел «Права (read-only):» | Разрешает читать записи (брони) | Владелец (owner), Управляющий (manager) |
Галочка repair_orders:read | Диалог «Создать ключ», раздел «Права (read-only):» | Разрешает читать наряды | Владелец (owner), Управляющий (manager) |
Галочка invoices:read | Диалог «Создать ключ», раздел «Права (read-only):» | Разрешает читать счета | Владелец (owner), Управляющий (manager) |
| Кнопка «Отмена» (в диалоге создания) | Диалог «Создать ключ» | Закрывает диалог без создания ключа | Владелец (owner), Управляющий (manager) |
| Кнопка «Создать ключ» (в диалоге создания) | Диалог «Создать ключ» | Создаёт ключ и открывает диалог с самим ключом. Недоступна (серая), пока не заполнено название или не выбрана хотя бы одна галочка прав | Владелец (owner), Управляющий (manager) |
| Кнопка «Копировать» (в диалоге с ключом) | Диалог «Ключ создан» | Копирует ключ в буфер обмена устройства | Владелец (owner), Управляющий (manager) |
| Поле с самим ключом (выделяемый текст) | Диалог «Ключ создан» | Можно выделить и скопировать вручную — тапнуть и удержать, затем «Выбрать всё» | Владелец (owner), Управляющий (manager) |
| Кнопка «OK» (в диалоге с ключом) | Диалог «Ключ создан» | Закрывает диалог. После закрытия ключ больше нигде не показывается | Владелец (owner), Управляющий (manager) |
Диалоги и подэкраны
Диалог «Создать ключ»
Открывается при нажатии плавающей кнопки «Создать ключ».
Поля:
- Название — обязательное текстовое поле. Придумайте понятное имя: например, «Яндекс.Метрика», «1С», «Сайт записи». Курсор автоматически встаёт в это поле при открытии диалога.
- Права (read-only): — список из пяти галочек. По умолчанию включена только
customers:read. Выберите только те разделы, которые нужны вашей программе: не давайте лишнего.
Кнопки:
- «Отмена» — закрыть без создания.
- «Создать ключ» — создать. Становится активной только когда заполнено название и выбрана хотя бы одна галочка. Пока идёт создание, галочки блокируются (не кликаются).
Диалог «Ключ создан»
Открывается сразу после успешного создания ключа.
Важно: это единственный момент, когда вы видите настоящий ключ. После закрытия диалога ключ нигде не хранится в читаемом виде — ни в приложении, ни на сервере. Восстановить невозможно — только создать новый.
Содержимое:
- Предупреждение: «Скопируйте ключ — он показывается один раз и больше не восстановится.»
- Сам ключ — длинная строка моноширинным шрифтом. Её можно выделить пальцем и скопировать вручную.
Кнопки:
- «Копировать» (с иконкой) — копирует ключ в буфер обмена одним нажатием.
- «OK» — закрыть диалог. Перед закрытием убедитесь, что скопировали ключ!
Что если…
На экране написано «Ключей пока нет»
— вы ещё не создавали ключей. Нажмите «Создать ключ» в правом нижнем углу.
Кнопка «Создать ключ» в диалоге серая и не нажимается
— либо не заполнено поле «Название», либо не отмечена ни одна галочка прав. Заполните название и выберите хотя бы один раздел.
Экран не загружается, показывает ошибку
— по центру экрана появится текст «Не удалось загрузить аналитику. Проверьте вход и сеть.» Закройте и откройте экран снова. Если при отзыве ключа произошла ошибка — внизу экрана появится сообщение «Повторить».
Нажал «OK» в диалоге с ключом, не скопировав его
— ключ потерян. Создайте новый: нажмите «Создать ключ», придумайте название, выберите те же права. Старый ключ стоит отозвать (он по-прежнему в списке), чтобы он не болтался без дела.
Хочу заблокировать ключ, который утёк или больше не нужен
— нажмите «Отозвать» напротив этого ключа. Программа, которая его использовала, сразу потеряет доступ.
Вопрос-ответ
Зачем вообще нужен API-ключ, если есть пароль от кабинета?
Ключ — для программ, не для людей. Вы даёте его своей бухгалтерской программе или сайту, чтобы они сами забирали данные, без вашего участия. При этом программа не знает ваш пароль и не может ничего изменить — только читать то, что вы разрешили.
В: Почему ключ показывается только один раз?
О: Так устроено в целях безопасности: даже если кто-то получит доступ к базе данных сервиса — настоящего ключа там нет, только его зашифрованный слепок. Поэтому скопируйте ключ сразу и сохраните в надёжном месте (например, в менеджере паролей).
В: Я забыл скопировать ключ и закрыл диалог. Что делать?
О: Создайте новый ключ с теми же правами, а старый отзовите кнопкой «Отозвать». Восстановить старый ключ невозможно.
В: Какие права ставить: все сразу или только нужные?
О: Только нужные. Если программа работает только со счетами — включите только invoices:read. Чем меньше прав, тем безопаснее: если ключ утечёт, ущерб будет минимальным.
В: Отозванный ключ остаётся в списке — это нормально?
О: Да. Отозванные ключи хранятся в истории: вы видите, что такой ключ когда-то был, и знаете, что он уже не работает. Удалить его из списка нельзя — это сделано намеренно для аудита.
В: Раздел «API-ключи» не виден в меню. Как получить доступ?
О: Раздел работает только на тарифе PRO. Попросите владельца сервиса перейти на PRO или уточните у него, есть ли у вашей роли доступ к настройкам организации.