REST API. Настройки модуля

Форма настроек

Форма настроек модуля REST API (Настройки > Настройки продукта > Настройки модулей > REST API) предназначена для задания параметров модуля.

Закладка Настройки

Поле	Описание
Модуль mod_zip включен и настроен (требуется для экспорта)	При отмеченной опции для экспорта архива приложения будет использоваться модуль mod_zip mod_zip - HTTP-модуль для NGINX, динамически собирающий ZIP-архивы. В простых конфигурациях mod_zip берет список файлов в локальной файловой системе и обслуживает их как один ZIP-архив. В более сложных настройках mod_zip может передавать файлы компонентов с вышестоящих серверов с помощью собственного прокси-кода NGINX. В отличие от многих сценариев создания ZIP, этот процесс никогда не занимает больше нескольких КБ ОЗУ, даже при сборке архивов, размер которых (потенциально) составляет сотни мегабайт. Подробнее... .
Максимальный размер импортируемого файла (МБ)	Устанавливается ограничение на размер файла импорта.

Поле

Описание

Модуль mod_zip включен и настроен (требуется для экспорта)

При отмеченной опции для экспорта архива приложения будет использоваться модуль mod_zip mod_zip - HTTP-модуль для NGINX, динамически собирающий ZIP-архивы. В простых конфигурациях mod_zip берет список файлов в локальной файловой системе и обслуживает их как один ZIP-архив. В более сложных настройках mod_zip может передавать файлы компонентов с вышестоящих серверов с помощью собственного прокси-кода NGINX. В отличие от многих сценариев создания ZIP, этот процесс никогда не занимает больше нескольких КБ ОЗУ, даже при сборке архивов, размер которых (потенциально) составляет сотни мегабайт.

Подробнее... .

Максимальный размер импортируемого файла (МБ)

Устанавливается ограничение на размер файла импорта.

Закладка Логирование

Поле	Описание
Активность логирования	Выполняется активация или отключение логирования.
Включить логирование	Устанавливается (выбирается из списка) время, на которое нужно включить лог использования RESTа.
Удалить собранные ранее данные	Выполняется удаление данных, собранных при предыдущем включении логирования.
Собрано данных	При нажатии на ссылку-число собранных данных можно просмотреть более подробный лог использования RESTа.
Настройки фильтрации
Идентификатор клиента (client_id)	Задаются параметры для выполнения импорта посредством REST. При большом объеме выгружаемых данных это значительно ускорит импорт. Подробное описание см. в документации по REST Как правильно выгружать большие объемы данных.
Идентификатор пароля (password_id)
Область видимости (scope)
Метод (method)
Идентификатор пользователя (user_id)

Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх