4. Настройки
В этом разделе представлены запросы, которые служат для получения информации о пользователе и юридическом лице. Также, в этом разделе представлены запросы для получения настроек системы.
Запросы для работы с пользователем:
| URI | Назначение | |
|---|---|---|
| 4.1 | /info/user/settings/ | Получить настройки текущего пользователя |
| 4.2 | /info/user/lastvisit/ | Получить информацию о последнем посещении личного кабинета |
Запрос получения настроек системы:
| URI | Назначение | |
|---|---|---|
| 4.3 | /info/organization/settings/ | Получить настройки системы |
| 4.4 | /info/organization/notifications/ | Получить сообщение информационного блока |
| 4.5 | /info/organization/fields/ | Получение списка полей, использующихся в форме оплаты, в платежах и в выставляемых счетах |
| 4.6 | /info/organization/reportemails/ | Получить список рассылки для уведомления о платежах |
| 4.7 | /info/organization/users/ | Получить список пользователей и их настройки |
| 4.8 | /info/organization/enabledbuttons/ | Получить список включенных кнопок платежных систем |
4.1. Запрос настроек текущего пользователя /info/user/settings/
Запрос возвращает информацию об имени текущего пользователя и возможности совершать возвраты. Для получения данных необходимо выполнить GET-запрос со следующими параметрами.
| Тип | Формат запроса | |
| GET | /info/user/settings/ | |
| Таблица 4.1.1. Параметры запроса | ||
В ответ возвращается объект следующего вида:
4.adminПризнак того, что пользователь является администратором. Принимает значения true/false.
| Тип | Формат ответа | ||
| Параметр | Назначение | ||
| 1. | user | Имя пользователя | |
| 2. | refund_allowed | Возможность осуществлять возвраты. Принимает значения: true/false. | |
| 3. | refund | Количество возвратов, которое пользователь может осуществить за сутки. | |
| Таблица 4.1.2. Параметры ответа | |||
Пример ответа на запрос:
|
1 2 3 4 5 6 |
{ "user" :"admin", "refund_allow":"true", "refund" : "0", "admin" : "true" } |
4.2. Запрос информации о последнем посещении пользователя /info/user/lastvisit/
Запрос возвращает информацию о последнем посещении пользователем личного кабинета платёжной платформы. В случае если это первый визит пользователя, возвращает текущее время. Для получения данных необходимо выполнить GET-запрос со следующими параметрами.
| Тип | Формат запроса | |
| GET | /info/user/lastvisit/ | |
| Таблица 4.2.1. Параметры запроса | ||
В ответ возвращается объект следующего вида:
| Тип | Формат ответа | ||
| Параметр | Назначение | ||
| 1. | ip | IP адрес последнего визита | |
| 2. | datetime | Дата и время последнего визита | |
| Таблица 4.2.2. Параметры ответа | |||
Пример ответа на запрос:
|
1 2 3 4 |
{ "ip" : "81.5.119.7", "datetime": "2014-06-20 13:30:52" } |
4.3. Запрос настроек /info/organization/settings/
Запрос возвращает информацию о настройках платёжной платформы. Пользователь, не являющийся администратором, получит только те свойства, которые отмечены в таблице флагом «все пользователи». Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/settings/ | |
| Таблица 4.3.1. Параметры запроса | ||
В ответ возвращается объект следующего вида:
| Тип | Формат ответа | ||
| Параметр | Назначение | Пользователи | |
| 1. | shopname | Название торговой точки | все |
| 2. | shopdomain | URL-сайта торговой точки | все |
| 3. | legal_name | Юридическое наименование организации | все |
| 4. | paykeeper_id | Номер договора | все |
| 5. | support_email | Почта для обращения в организацию | администратор |
| 6. | informer_type | Режим работы информера, принимает значение post или email | администратор |
| 7. | informer_url | URL уведомления для информера по которому отправляется информация о принятом платеже | администратор |
| 8. | informer_seed | Секретное слово для подписи сообщений информера | администратор |
| 9. | smtp_use_custom | Флаг использования стандартных настроек SMTP сервера платёжной платформы. Если указано значение ‘true’, то для отправки писем используются настройки указанные в параметрах smtp_host, smtp_port, smtp_user, smtp_password. Если указано ‘false’, то используются настройки почтового сервера по умолчанию и параметры smtp_host, smtp_port, smtp_user, smtp_password не возвращаются в запросе. | администратор |
| 10. | smtp_host | Адрес SMTP сервера | администратор |
| 11. | smtp_port | Порт SMTP сервера | администратор |
| 12. | smtp_user | Имя пользователя SMTP в формате адреса электронной почты | администратор |
| 13. | smtp_password | Пароль пользователя SMTP | администратор |
| 14. | skip_default_pages | Флаг указывает на то, что нужно пропускать стандартные страницы возврата и сразу отправлять пользователя на сайт торговой точки. Принимает значения true или false | администратор |
| 15. | success_url | URL для возврата в случае успешной оплаты | администратор |
| 16. | fail_url | URL для возврата в случае ошибки при оплате | администратор |
| 17. | cabinet | Массив с флагами, указывающие на необходимость скрытия вкладок или кнопок | все |
| Таблица 4.3.2. Параметры ответа | |||
Пример ответа на запрос:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
{ "shopname" : "Магазин example.com", "shopdomain" : "http://example.com", "legal_name" : "ООО МАГАЗИН", "paykeeper_id" : "140221-031-1", "support_email" : "support@example.com" "informer_type" : "email" "informer_url" : "http://mysite.ru/postinform.php" "informer_seed" : "secretpassword" "smtp_use_custom": "true" "smtp_user" : "mymail@ya.ru" "smtp_password" : "mypasswd" "smtp_host" : "ssl://smtp.yandex.ru" "smtp_port" : "465" "skip_default_pages": "true" "success_url" : "http://example.com/success/" "fail_url" : "http://example.com/fail/" "cabinet" : {hide_statistics: "false", hide_payments: "false", hide_invoices: "false", hide_receipts: "false",…} } |
Настройки личного кабинета — SMTP-сервер
Настройки личного кабинета — адреса перенаправления клиента
4.4. Запрос информационных сообщений для организации /info/organization/notifications/
Запрос возвращает информационные сообщения, подготовленные для организации. Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/notifications/ | |
| Таблица 4.4.1. Параметры запроса | ||
В ответ возвращается массив объектов следующего вида:
| Тип | Формат ответа | |
| Параметр | Назначение | |
| 1. | type | Тип сообщения. Может принимать значения important , bottom, bottom_important |
| 2. | message | HTML-код сообщения |
| 3. | link | Ссылка для отображения в области ссылок, если тип сообщения предусматривает ссылку (значение атрибута href) |
| 4. | link_caption | Текст ссылки link |
| Таблица 4.4.2. Параметры ответа | ||
Пример ответа на запрос:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
[ { "type": "important", "message": "<strong>ВНИМАНИЕ:</strong> ДО КОНЦА ПЕРИОДА ПОДДЕРЖКИ И ОБНОВЛЕНИЙ <strong>ОСТАЛОСЬ 10 ДНЕЙ</strong>", "link": "https://paykeeper.ru/paykeeper/pay/tech/", "link_caption": "ПРОДЛИТЬ" }, { type: "bottom", "message": "до конца периода обновлений и поддержки <em>осталось 255 дней</em>", "link": "https://paykeeper.ru/paykeeper/pay/tech/", "link_caption": "Обратиться в службу поддержки" } ] |
4.5. Запрос на получение списка используемых полей /info/organization/fields/
Запрос возвращает поля, которые используются в форме оплаты, в платежах и в выставляемых счетах. В запросе возвращается название поля в системе, название поля для отображения, значение поля по умолчанию, информация является ли поле активным и является ли поле обязательным для заполнения, а также тип поля и порядок сортировки в форме. Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/fields/ | |
| Таблица 4.5.1. Параметры запроса | ||
В ответ возвращается массив объектов следующего вида:
| Тип | Формат ответа | |
| Параметр | Назначение | |
| 1. | pk_name | Название поле в платёжной платформы |
| 2. | displayed_name | Название поле для отображения пользователю |
| 3. | required | Признак того, что поле является обязательным для заполнения. Принимает значения true,false |
| 4. | placeholder | Значение поля по умолчанию |
| 5. | enabled | Признак того, что поле является активным и его нужно использовать. Принимает значения true,false |
| 6. | type | Тип поля. Может принимать значения: sum, text, phone, email, bool |
| 7. | order | Порядок сортировки в форме. Может принимать целые значения от 0 до 10 000. Сортировка происходит по возрастанию этого значения |
| Таблица 4.5.2. Параметры ответа | ||
Пример ответа на запрос:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
[ { "pk_name" :"clientid", "displayed_name" :"Фамилия Имя Отчество", "placeholder" :"Иванов Иван Иванович", "required" :"true", "enabled" :"true", "required" :"false", "order" :"20", "type" :"clientid" }, … ] |
Настройки личного кабинета — настройка формы оплаты
4.6. Запрос на получение списка рассылки для уведомления о платежах /info/organization/reportemails/
Запрос возвращает список адресов электронной почты, на которую осуществляется рассылка уведомлений о принятых платежах. Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/reportemails/ | |
| Таблица 4.6.1. Параметры запроса | ||
В ответ возвращается массив объектов следующего вида:
| Тип | Формат ответа | |
| Параметр | Назначение | |
| 1. | id | Идентификатор |
| 2. | Адрес электронной почты | |
| Таблица 4.6.2. Параметры ответа | ||
Пример ответа на запрос:
|
1 2 3 4 5 6 7 |
[ { "id" : "1", "email": "support@paykeeper.ru" }, … ] |
Настройки личного кабинета — получение информации о платежах
4.7. Запрос на получение списка пользователей и их настроек /info/organization/users/
Запрос возвращает список пользователей платёжной платформы вместе с их настойками. Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/users/ | |
| Таблица 4.7.1. Параметры запроса | ||
В ответ возвращается массив объектов следующего вида:
| Тип | Формат ответа | |
| Параметр | Назначение | |
| 1. | id | Идентификатор пользователя |
| 2. | login | Логин пользователя |
| 3. | refund | Количество возвратов которые пользователь может сделать за сутки. Если установлено «0», то функция возврата для этого пользователя недоступна |
| 4. | admin | Признак того, что пользователь является администратором. Принимает значения true/false |
| Таблица 4.7.2. Параметры ответа | ||
Пример ответа на запрос:
|
1 2 3 4 5 6 7 8 9 |
[ { "id" : "1", "login" : "admin", "refund": "0", "admin" : "true" }, … ] |
Настройки личного кабинета — доступ к панели администратора
4.8. Запрос на получение включенных кнопок платежных систем /info/organization/enabledbuttons/
Запрос возвращает список пользователей платёжной платформыr вместе с их настойками. Для получения данных необходимо выполнить следующий GET-запрос.
| Тип | Формат запроса | |
| GET | /info/organization/enabledbuttons/ | |
| Таблица 4.8.1. Параметры запроса | ||
В ответ возвращается массив следующего вида:
|
1 |
["opb.applepay","opb.visa","opb.master","opb.mir","opb.googlepay","opb.yandexpay","bspb.visa","bspb.master"] |