Установка
1. Подготовьте сайт
- Проверьте системные требования.
- Войдите в административный раздел сайта под администратором.
- Убедитесь, что в браузере включён JavaScript: он нужен мастеру установки.
Первую установку и проверку выполняйте на тестовом сайте.
2. Загрузите модуль
- Откройте карточку модуля в Маркетплейсе.
- Нажмите «Установить» и укажите адрес тестового сайта.
- Следуйте указаниям Маркетплейса для загрузки модуля на сайт.
Модуль также можно найти по коду «native.api» в разделе «Marketplace → Каталог решений». Демонстрационный период — 14 дней.
Для загрузки требуется активный срок получения обновлений 1С-Битрикс.
Если у вас есть купон, сначала активируйте его: «Marketplace → Обновление решений → Активация купона». Затем загрузите доступную версию модуля.
3. Выполните установку
- Откройте «Marketplace → Установленные решения».
- Найдите «API-платформа» и выберите «Установить модуль».
- На вкладке «Компоненты установки» нажмите «Продолжить установку».
- Дождитесь сообщения «Все компоненты установлены».
- Нажмите «Перейти к модулю».
Результат: открылся дашборд модуля. Он также доступен через «Сервисы → API-платформа → Дашборд».
При первой установке API ещё нужно настроить. Перейдите к запуску.
Флажки компонентов установки
Семь флажков на вкладке «Компоненты установки» — индикаторы выполнения. Их нельзя выбирать или снимать: мастер отмечает их автоматически после каждого этапа. Все этапы обязательны.
| Компонент | Что делает мастер |
|---|---|
| Ключ хеширования токенов | Создаёт ключ, если его ещё нет. При повторной установке сохранённый ключ используется снова |
| Таблицы базы данных | Создаёт недостающие таблицы модуля; сохранённые таблицы и данные остаются |
| Обработчики событий | Регистрирует обработчики событий Битрикса |
| Административные файлы, сервисы, компоненты и гаджеты | Устанавливает файлы для работы модуля и его административного раздела |
| Точки входа API и документации | Восстанавливает точки входа по сохранённым путям. При первой установке пути задаются на этапе запуска |
| Кеш модуля | Очищает кеш модуля |
| Регистрация модуля и раздел «API-платформа» в меню «Сервисы» | Регистрирует модуль и добавляет его раздел в административное меню |
Если вы переустанавливаете модуль, сохранение данных зависит от флажков, выбранных при удалении.
Если установка прервалась
- Прочитайте сообщение мастера и устраните указанную причину.
- Нажмите «Повторить».
- Дождитесь завершения установки.
Если версия PHP не подходит, смените её для сайта согласно системным требованиям и снова откройте мастер.