5. Модификация настроек

С помощью протокола JSON API можно менять многие глобальные настройки системы. Потребоваться это может, в основном, в том случае, если существует потребность продублировать функционал настроек личного кабинета PayKeeper где-либо в информационной системе. Например, добавить возможность изменять адреса для рассылки почты из CRM системы предприятия.

Изменять можно следующие настройки системы:

Информация об организации
Настройки формы оплаты
Поведение системы после получения платежа
Настойки пользователей PayKeeper
Адреса перенаправлений

	URI	Назначение
5.1	URI:/change/organization/setting/	Назначение:Запрос на изменение параметра настроек PayKeeper
5.2	URI:/change/organization/formfield/	Назначение:Запрос на изменения поля формы
5.3	URI:/change/organization/addreportemail/	Назначение:Запрос на добавление адреса в список рассылки уведомлений о принятых платежах
5.4	URI:/change/organization/deletereportemail/	Назначение:Запрос на удаление адреса из списка рассылки уведомлений о принятых платежах
5.5	URI:RESERVE	Назначение:
5.6	URI:/change/user/add/	Назначение:Запрос на добавление пользователя
5.7	URI:/change/user/update/	Назначение:Запрос на изменение существующего пользователя
5.8	URI:/change/user/delete/	Назначение:Запрос на удаление пользователя

5.1. Запрос на изменение параметра /change/organization/setting/

Запрос модификации параметра PayKeeper. Для модификации нужно задать имя модифицируемого параметра (name) и его новое значение (value). Если новое значение не указано, модификации не произойдет.

Список настроек, которые можно редактировать с помощью запроса:

Тип	Изменяемые настройки
	Параметр	Назначение
1.	Параметр:support_email	Назначение:Почта для обращения в организацию
2.	Параметр:informer_type	Назначение:Режим работы информера, принимает значение post или email
3.	Параметр:informer_url	Назначение:URL-уведомления для информера, по которому отправляется информация о принятом платеже
4.	Параметр:informer_seed	Назначение:Секретное слово для подписи сообщений информера
5.	Параметр:smtp_use_custom	Назначение:Флаг использования стандартных настроек SMTP-сервера PayKeeper. Если указано значение ‘true’, то для отправки писем используются настройки, указанные в параметрах smtp_host, smtp_port, smtp_user, smtp_password. Если указано ‘false’, то используются настройки почтового сервера PayKeeper по умолчанию и параметры smtp_host, smtp_port, smtp_user, smtp_password не возвращаются в запросе
6.	Параметр:smtp_host	Назначение:Адрес SMTP-сервера
7.	Параметр:smtp_port	Назначение:Порт SMTP-сервера
8.	Параметр:smtp_user	Назначение:Имя пользователя SMTP в формате адреса электронной почты
9.	Параметр:smtp_password	Назначение:Пароль пользователя SMTP
10.	Параметр:skip_default_pages	Назначение:Флаг указывает на то, что нужно пропускать стандартные страницы возврата paykeeper и сразу отправлять пользователя на сайт торговой точки. Принимает значения true или false
11.	Параметр:success_url	Назначение:URL для возврата в случае успешной оплаты
12.	Параметр:fail_url	Назначение:URL для возврата в случае ошибки при оплате
Таблица 5.1.1. Изменяемые настройки

Для изменения параметра нужно выполнить POST-запрос со следующими параметрами:

Тип	Формат запроса
Тип:POST	Формат запроса:/change/organization/setting/

	Параметр	Назначение
1.	Параметр:name	Назначение:Название параметра PayKeeper
2.	Параметр:value	Назначение:Новое значение настройки
3.	Параметр:token	Назначение:Токен безопасности
Таблица 5.1.2. Параметры запроса

Результатом данного запроса будет объект:

{ 
  "result" : "success"
}

{

"result" : "success"

}

5.2. Запрос на изменение поля /change/organization/formfield/

Запрос модификации поля, которое используются в форме оплаты, в платежах и в выставляемых счетах. Запрос модифицирует одно из полей по имени поля (pk_name) и устанавливает новые значения для placeholder, displayed_name, required, placeholder, enabled, type, order. Если какое-либо из новых значений не указано, то старое изменено не будет. Поле sum изменить нельзя, в случае указания значения pk_name равным sum будет возвращена ошибка.

Тип	Формат запроса
Тип:POST	Формат запроса:/change/organization/formfield/

	Параметр	Назначение
1.	Параметр:pk_name	:Название параметра PayKeeper
2.	Параметр:displayed_name	Назначение:Название поля для отображения пользователю
3.	Параметр:required	Назначение:Признак того, что поле является обязательным для заполнения. Принимает значения true,false
4.	Параметр:placeholder	Назначение:Значение поля по умолчанию
5.	Параметр:enabled	Назначение:Признак того, что поле является активным и его нужно использовать. Принимает значения true,false
6.	Параметр:type	Назначение:Тип поля. Может принимать значения: ‘sum’, ‘clientid’, ‘orderid’, ‘text’, ‘phone’, ’email’, ‘bool’
7.	Параметр:order	Назначение:Порядок сортировки в форме. Может принимать целые значения от 0 до 10 000. Сортировка происходит по возрастанию этого значения
8.	Параметр:token	Назначение:Токен безопасности
Таблица 5.2.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success"
}

{

"result" : "success"

}

5.3. Запрос на добавление адреса в список рассылки уведомлений о принятых платежах /change/organization/addreportemail/

Запрос добавляет новый адрес для рассылки почтовых уведомлений о принятых платежах. Для добавления адреса нужно выполнить следующий POST-запрос:

Тип	Формат запроса
Тип:POST	Формат запроса:/change/organization/addreportemail/

	Параметр	Назначение
1.	Параметр:email	Назначение:Адрес электронной почты
2.	Параметр:token	Назначение:Токен безопасности
Таблица 5.3.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success"
}

{

"result" : "success"

}

5.4. Запрос на удаление адреса из списка рассылки уведомлений о принятых платежах /change/organization/deletereportemail/

Запрос удаляет адрес из списка рассылки почтовых уведомлений. Для удаления адреса нужно выполнить следующий POST-запрос, передав идентификатор почтового адреса.

Тип	Формат запроса
Тип:POST	Формат запроса:/change/organization/deletereportemail/

	Параметр	Назначение
1.	Параметр:id	Назначение:Идентификатор адреса электронной почты
2.	Параметр:token	Назначение:Токен безопасности
Таблица 5.4.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success"
}

{

"result" : "success"

}

5.6. Запрос на добавление пользователя /change/user/add/

Запрос добавляет нового пользователя в систему PayKeeper. Для добавления нужно выполнить следующий POST-запрос:

Тип	Формат запроса
Тип:POST	Формат запроса:/change/user/add/

	Параметр	Назначение
1.	Параметр:login	Назначение:Логин пользователя
2.	Параметр:password	Назначение:Пароль пользователя
3.	Параметр:email	Назначение:Адрес электронной почты пользователя
4.	Параметр:refund	Назначение:Количество возвратов, которое пользователь может осуществить за сутки.
5.	Параметр:admin	Назначение:Признак того, что пользователь является администратором. Принимает значения true/false.
6.	Параметр:token	Назначение:Токен безопасности
Таблица 5.6.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success",
  "user_id" : 53
}

{

"result" : "success",

"user_id" : 53

}

5.7 Запрос на изменение существующего пользователя /change/user/update/

Запрос на изменение пользователя системы PayKeeper. Запрос корректирует настойки пользователя с заданными login. Если часть параметров не указано, то они будет пропущены. Для выполнения запроса нужно выполнить следующий POST-запрос:

Тип	Формат запроса
Тип:POST	Формат запроса:/change/user/update/

	Параметр	Назначение
1.	Параметр:id	Назначение:Идентификатор пользователя
2.	Параметр:login	Назначение:Логин пользователя
3.	Параметр:email	Назначение:Адрес электронной почты пользователя
4.	Параметр:password	Назначение:Пароль пользователя
5.	Параметр:refund	Назначение:Количество возвратов, которое пользователь может осуществить за сутки
6.	Параметр:admin	Назначение:Признак того, что пользователь является администратором. Принимает значения true/false
7.	Параметр:token	Назначение:Токен безопасности
Таблица 5.6.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success"
}

{

"result" : "success"

}

5.8 Запрос на удаление пользователя /change/user/delete/

Запрос на удаление пользователя из системы PayKeeper. Запрос удаляет пользователя с указанным login. Для удаления пользователя нужно выполнить следующий POST-запрос:

Тип	Формат запроса
Тип:POST	Формат запроса:/change/user/delete/

	Параметр	Назначение
1.	Параметр:id	Назначение:Идентификатор пользователя
2.	Параметр:token	Назначение:Токен безопасности
Таблица 5.7.1. Параметры запроса

Результатом данного запроса будет объект

{ 
  "result" : "success"
}

{

"result" : "success"

}