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

Установка

1. Подготовьте сайт

  1. Проверьте системные требования.
  2. Войдите в административный раздел сайта под администратором.
  3. Убедитесь, что в браузере включён JavaScript: он нужен мастеру установки.

Первую установку и проверку выполняйте на тестовом сайте.

2. Загрузите модуль

  1. Откройте карточку модуля в Маркетплейсе.
  2. Нажмите «Установить» и укажите адрес тестового сайта.
  3. Следуйте указаниям Маркетплейса для загрузки модуля на сайт.

Модуль также можно найти по коду «native.api» в разделе «Marketplace → Каталог решений». Демонстрационный период — 14 дней.

Для загрузки требуется активный срок получения обновлений 1С-Битрикс.

Если у вас есть купон, сначала активируйте его: «Marketplace → Обновление решений → Активация купона». Затем загрузите доступную версию модуля.

3. Выполните установку

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

Результат: открылся дашборд модуля. Он также доступен через «Сервисы → API-платформа → Дашборд».

При первой установке API ещё нужно настроить. Перейдите к запуску.

Флажки компонентов установки

Семь флажков на вкладке «Компоненты установки» — индикаторы выполнения. Их нельзя выбирать или снимать: мастер отмечает их автоматически после каждого этапа. Все этапы обязательны.

КомпонентЧто делает мастер
Ключ хеширования токеновСоздаёт ключ, если его ещё нет. При повторной установке сохранённый ключ используется снова
Таблицы базы данныхСоздаёт недостающие таблицы модуля; сохранённые таблицы и данные остаются
Обработчики событийРегистрирует обработчики событий Битрикса
Административные файлы, сервисы, компоненты и гаджетыУстанавливает файлы для работы модуля и его административного раздела
Точки входа API и документацииВосстанавливает точки входа по сохранённым путям. При первой установке пути задаются на этапе запуска
Кеш модуляОчищает кеш модуля
Регистрация модуля и раздел «API-платформа» в меню «Сервисы»Регистрирует модуль и добавляет его раздел в административное меню

Если вы переустанавливаете модуль, сохранение данных зависит от флажков, выбранных при удалении.

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

  1. Прочитайте сообщение мастера и устраните указанную причину.
  2. Нажмите «Повторить».
  3. Дождитесь завершения установки.

Если версия PHP не подходит, смените её для сайта согласно системным требованиям и снова откройте мастер.