Установка

API методы для установки.

GET /api/setup/admin_checklist

Возвращает различные шаги «контрольного списка администратора» вместе с информацией о том, были ли они выполнены.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

GET /api/setup/user_defaults

Возвращает объект, содержащий сведения о пользователе по умолчанию для первоначальной настройки, если он настроен и если предоставленное значение токена соответствует токену в значении конфигурации.

Параметры:

  • token

POST /api/setup/

Специальный метод для создания первого пользователя во время установки. Этот метод создает пользователя, осуществляет его вход в систему и возвращает ID сессии. Данный метод может быть использован для добавления базы данных, создания и инициации второго администратора, и/или устанавливания специальных настроек, задаваемых в процессе установки.

Параметры:

  • engine

  • schedules значение может быть пусты, или если не пустое, значение должно быть действительной картой из расписаний для этой БД.

  • allow_tracking значение может быть пустым, или если не пустое, значение должно удовлетворять одному из двух требований: 1) значение должно быть булевым. 2) значение должно быть допустимой логической строкой (”true” или “false”).

  • invited_last_name значение может быть null, или если не null, значение должно быть не пустой строкой.

  • site_locale значение может быть пустым, или если не пустое, строка должна быть допустимым двухбуквенным ISO языком или языком страны кода, например английским или американским английским.

  • email vзначение должно быть действительным адресом электронной почты.

  • first_name значение может быть null, или если не null, значение должно быть не пустой строкой.

  • request

  • auto_run_queries значение может быть пустым, или если не пустое, значение должно быть логическим.

  • password пароль

  • name

  • invited_email значение может быть пустым, или если не пустое, значение должно быть действительным адресом эл. почты.

  • invited_first_name значение может быть null, или если не null, значение должно быть не пустой строкой.

  • site_name значение должно быть не пустой строкой.

  • token Токен не соответствующий токену установки.

  • details

  • database

  • last_name значение может быть null, или если не null, значение должно быть не пустой строкой.

POST /api/setup/validate

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

Параметры:

  • engine значение должно быть действительным механизмом базы данных.

  • details

  • token Токен не соответствует токену установки.

<< Назад к разделу API