Документация1С-Битрикс: Модулиnative.apiНачало работы

Удаление модуля

Мастер удаляет модуль и позволяет отдельно выбрать данные для очистки. До удаления сохраните резервную копию нужных данных и согласуйте остановку интеграций: после удаления API и встроенная документация будут недоступны.

Процедура удаления

  1. Войдите в административный раздел под администратором.
  2. Откройте «Marketplace → Установленные решения».
  3. Найдите «API-платформа» и выберите «Удалить».
  4. На вкладке «Удаление данных» отметьте только данные, которые нужно очистить.
  5. Нажмите «Продолжить удаление» и подтвердите удаление модуля и выбранных данных.
  6. Дождитесь завершения мастера и вернитесь к списку модулей.

По умолчанию все семь флажков сняты. «Отметить все» включает полную очистку. Выбранные данные удаляются без возможности восстановления через мастер.

Флажки удаления данных

ФлажокЧто удаляется при включении
Журнал событийЗаписи этого модуля в системном журнале Битрикса. События других модулей остаются
Файловые журналыКаталог native.api в настроенном пути логирования. Журналы в ранее использованных путях нужно очищать отдельно
Входящие запросыТаблицы истории запросов, входящих данных и ответов
Статистика запросовТаблица накопленных счётчиков запросов по HTTP-методам
Токены авторизацииКлюч хеширования меняется для отключения клиентов, затем удаляется таблица токенов
Настройки дашбордаПерсональные и общие настройки дашборда
Настройки модуляНастройки и права доступа к модулю. Ключ хеширования сохраняется, если таблица токенов остаётся

Флажки независимы. Например, удаление истории запросов не очищает файловые журналы, а удаление файловых журналов не удаляет записи системного журнала.

Что удаляется всегда

Независимо от флажков мастер удаляет точки входа API и документации, служебные и административные файлы, компоненты и гаджеты модуля, очищает его кеш, снимает обработчики событий и регистрацию модуля. Снятые флажки сохраняют соответствующие данные, но не оставляют API работающим.

Повторная установка

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

  • Если сохранены настройки модуля, мастер восстанавливает точки входа по сохранённым путям.
  • Если настройки удалены, заново выполните настройку и запуск, включая права доступа.
  • Если токены сохранены, их ключ хеширования сохраняется даже при удалении остальных настроек. Сроки действия токенов продолжают идти во время отсутствия модуля.
  • Если токены удалены, старые токены больше не работают: после установки клиентам потребуется новая авторизация.

После переустановки выполните базовую проверку API.

Если удаление прервалось

Устраните причину, указанную мастером, и нажмите «Повторить». Уже выполненная очистка не откатывается: часть выбранных данных может быть удалена до ошибки. Дождитесь завершения мастера, прежде чем устанавливать модуль снова.