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

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

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

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

 

  URI Назначение
5.1 /change/organization/setting/ Запрос на изменение параметра настроек PayKeeper
5.2 /change/organization/formfield/ Запрос на изменения поля формы
5.3 /change/organization/addreportemail/ Запрос на добавление адреса в список рассылки уведомлений о принятых платежах
5.4 /change/organization/deletereportemail/ Запрос на удаление адреса из списка рассылки уведомлений о принятых платежах
5.5 RESERVE
5.6 /change/user/add/ Запрос на добавление пользователя
5.7 /change/user/update/ Запрос на изменение существующего пользователя
5.8 /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 и сразу отправлять пользователя на сайт торговой точки. Принимает значения on или off
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. Параметры запроса

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

 

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. Параметры запроса

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

 

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

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

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

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

 

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

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

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

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

 

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

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

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

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

 

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

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

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

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

 

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

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

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

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