Настройки

Управление настройками установки осуществляется с помощью ресурса /settings

Метод Ресурс Результат
GET /settings Получить настройки установки
POST /settings Изменить настройки установки

Получение настроек установки

Чтобы получить настройки установки, необходимо выполнить запрос GET /settings.

Пример:

$ curl --request GET \
       --include \
       --user "admin:admin" \
       --url http://api.example.com/settings

HTTP/1.1 200 OK
Server: nginx/1.4.6 (Ubuntu)
Date: Wed, 04 Mar 2015 06:57:20 GMT
Content-Type: application/json
Content-Length: 63
Connection: keep-alive

{
  "moderate_updated_banners":true,
  "moderation":"disabled"
}

Только пользователям с ролью administrator разрешено чтение настроек установки.

Изменение настроек установки

Чтобы изменить настройки, необходимо выполнить запрос POST /settings с JSON-документом в теле вида:

Поле Описание Обязателен Разрешенные значения
moderation Режим модерации Нет disabled, pre, post
moderate_updated_banners Ремодерация измененных баннеров Нет true, false

Пример:

$ curl --request POST \
       --include \
       --user "admin:admin" \
       --header "Content-Type: application/json" \
       --data \
       '{
          "moderation":"pre",
          "moderate_updated_banners":true
        }' \
       --url http://api.example.com/settings

HTTP/1.1 200 OK
Server: nginx/1.4.6 (Ubuntu)
Date: Wed, 04 Mar 2015 07:08:58 GMT
Content-Type: application/json
Content-Length: 58
Connection: keep-alive

{
  "moderate_updated_banners":true,
  "moderation":"pre"
}

Только пользователям с ролью administrator разрешено изменение настроек установки.