4. Информация о системе

В этом разделе представлены запросы, которые служат для получения информации о пользователе и юридическом лице. Также, в этом разделе представлены запросы для получения настроек системы.

Запросы для работы с пользователем:

	URI	Назначение
4.1	URI:/info/user/settings/	Назначение:Получить настройки текущего пользователя
4.2	URI:/info/user/lastvisit/	Назначение:Получить информацию о последнем посещении личного кабинета

Запрос получения настроек системы:

	URI	Назначение
4.3	URI:/info/organization/settings/	Назначение:Получить настройки системы
4.4	URI:/info/organization/notifications/	:Получить сообщение информационного блока
4.5	URI:/info/organization/fields/	Назначение:Получение списка полей, использующихся в форме оплаты, в платежах и в выставляемых счетах
4.6	URI:/info/organization/reportemails/	Назначение:Получить список рассылки для уведомления о платежах
4.7	URI:/info/organization/users/	Назначение:Получить список пользователей и их настройки
4.8	URI:/info/organization/enabledbuttons/	Назначение:Получить список включенных кнопок платёжных систем

4.1. Запрос настроек текущего пользователя /info/user/settings/

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

Тип	Формат запроса
Назначение:GET	Формат запроса:/info/user/settings/
Таблица 4.1.1. Параметры запроса

В ответ возвращается объект следующего вида:

3.refundКоличество возвратов, которое пользователь может осуществить за сутки.

Тип	Формат ответа
	Параметр	Назначение
1.	Параметр:id	Назначение:Идентификатор пользователя
2.	Параметр:login	Назначение:Имя пользователя
4.	Параметр:admin	Назначение:Признак того, что пользователь является администратором. Принимает значения true/false.
5.	Параметр:invoices_only	Назначение:Признак того, что права пользователя ограничиваются только возможностью выставления счетов. Принимает значения: true/false.
6.	Параметр:email	Назначение:Адрес электронной почты пользователя. Для получения уведомлений, восстановления пароля и работы с дополнительными сервисами.
7.	Параметр:refund_allow	Назначение:Возможность осуществлять возвраты. Принимает значения true/false.
Таблица 4.1.2. Параметры ответа

Пример ответа на запрос:

{
     "id"            : "3",
     "login"         : "admin",
     "refund"        : "3",
     "admin"         : "true",
     "invoices_only" : "false",
     "email"         : "test@example.com",
     "refund_allow"  : "true"
}

{

"id" : "3",

"login" : "admin",

"refund" : "3",

"admin" : "true",

"invoices_only" : "false",

"email" : "test@example.com",

"refund_allow" : "true"

}

4.2. Запрос информации о последнем посещении пользователя /info/user/lastvisit/

Запрос возвращает информацию о последнем посещении пользователем личного кабинета PayKeeper. В случае если это первый визит пользователя, возвращает текущее время. Для получения данных необходимо выполнить GET-запрос со следующими параметрами.

Тип	Формат запроса
Тип:GET	Формат запроса:/info/user/lastvisit/
Таблица 4.2.1. Параметры запроса

В ответ возвращается объект следующего вида:

Тип	Формат ответа
	Параметр	Назначение
1.	Параметр:ip	Назначение:IP-адрес последнего визита
2.	Параметр:datetime	Назначение:Дата и время последнего визита
Таблица 4.2.2. Параметры ответа

Пример ответа на запрос:

{
     "ip"      : "81.5.119.7",
     "datetime": "2014-06-20 13:30:52"
}

{

"ip" : "81.5.119.7",

"datetime": "2014-06-20 13:30:52"

}

4.3. Запрос настроек /info/organization/settings/

Запрос возвращает информацию о настройках PayKeeper. Пользователь, не являющийся администратором, получит только те свойства, которые отмечены в таблице флагом «все пользователи». Для получения данных необходимо выполнить следующий 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-сервера PayKeeper. Если указано значение ‘true’, то для отправки писем используются настройки, указанные в параметрах smtp_host, smtp_port, smtp_user, smtp_password. Если указано ‘false’, то используются настройки почтового сервера PayKeeper по умолчанию и параметры 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	Назначение:Флаг указывает на то, что нужно пропускать стандартные страницы возврата paykeeper и сразу отправлять пользователя на сайт торговой точки. Принимает значения true или false	Пользователи:администратор
15.	Параметр:success_url	Назначение:URL для возврата в случае успешной оплаты	Пользователи:администратор
16.	Параметр:fail_url	Назначение:URL для возврата в случае ошибки при оплате	Пользователи:администратор
17.	Параметр:cabinet	Назначение:Массив с флагами, указывающие на необходимость скрытия вкладок или кнопок	Пользователи:все
18.	Параметр:currency	Назначение:Валюта, используемая по умолчанию	Пользователи:все
19.	Параметр:email	Назначение:Email-адрес текущего пользователя	Пользователи:все
Таблица 4.3.2. Параметры ответа

Пример ответа на запрос:

{
     "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",…},
     "email"              : "test@example.com"
}

{

"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",…},

"email" : "test@example.com"

}

Настройки личного кабинета — общие параметры

Настройки личного кабинета — 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. Параметры ответа

Пример ответа на запрос:

[
   {
      "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": "Обратиться в службу поддержки"
   }
]

[

{

"type": "important",

"message": "ВНИМАНИЕ: ДО КОНЦА ПЕРИОДА ПОДДЕРЖКИ И ОБНОВЛЕНИЙ ОСТАЛОСЬ 10 ДНЕЙ",

"link": "https://paykeeper.ru/paykeeper/pay/tech/",

"link_caption": "ПРОДЛИТЬ"

{

type: "bottom",

"message": "до конца периода обновлений

и поддержки осталось 255 дней",

"link": "https://paykeeper.ru/paykeeper/pay/tech/",

"link_caption": "Обратиться в службу поддержки"

}

]

4.5. Запрос на получение списка используемых полей /info/organization/fields/

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

Тип	Формат запроса
Тип:GET	Формат запроса:/info/organization/fields/
Таблица 4.5.1. Параметры запроса

В ответ возвращается массив объектов следующего вида:

Тип	Формат ответа
	Параметр	Назначение
1.	Параметр:pk_name	Назначение:Название поля в PayKeeper
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. Параметры ответа

Пример ответа на запрос:

[
	{
	"pk_name"         :"clientid",
	"displayed_name"  :"Фамилия Имя Отчество",
	"placeholder"     :"Иванов Иван Иванович",
	"required"        :"true",
	"enabled"         :"true",
	"required"        :"false",
	"order"           :"20",
	"type"            :"clientid"
	},
…
]

[

{

"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.	Параметр:email	Назначение:Адрес электронной почты
Таблица 4.6.2. Параметры ответа

Пример ответа на запрос:

[
	{
	"id"   : "1",
	"email": "support@paykeeper.ru"
	},
…
]

[

{

"id" : "1",

"email": "support@paykeeper.ru"

…

]

Настройки личного кабинета — получение информации о платежах

4.7. Запрос на получение списка пользователей и их настроек /info/organization/users/

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

Тип	Формат запроса
Тип:GET	Формат запроса:/info/organization/users/
Таблица 4.7.1. Параметры запроса

В ответ возвращается массив объектов следующего вида:

3.refundКоличество возвратов, которое пользователь может осуществить за сутки.

Тип	Формат ответа
	Параметр	Назначение
1.	Параметр:id	Назначение:Идентификатор пользователя.
2.	Параметр:login	Назначение:Имя пользователя.
4.	Параметр:admin	Назначение:Признак того, что пользователь является администратором. Принимает значения true/false.
5.	Параметр:invoices_only	Назначение:Признак того, что права пользователя ограничиваются только возможностью выставления счетов. Принимает значения: true/false.
6.	Параметр:email	Назначение:Адрес электронной почты пользователя. Для получения уведомлений, восстановления пароля и работы с дополнительными сервисами.
7.	Параметр:refund_allow	Назначение:Возможность осуществлять возвраты. Принимает значения true/false.
Таблица 4.7.2. Параметры ответа

Пример ответа на запрос:

[
 	{
             "id"            : "3",
             "login"         : "admin",
             "refund"        : "3",
             "admin"         : "true",
             "invoices_only" : "false",
             "email"         : "test@example.com",
             "refund_allow"  : "true"
	},
…
]

[

{

"id" : "3",

"login" : "admin",

"refund" : "3",

"admin" : "true",

"invoices_only" : "false",

"email" : "test@example.com",

"refund_allow" : "true"

…

]

Настройки личного кабинета — доступ к панели администратора

4.8. Запрос на получение включенных кнопок платёжных систем /info/organization/enabledbuttons/

Тип	Формат запроса
Тип:GET	>Формат запроса:/info/organization/enabledbuttons/
Таблица 4.8.1. Параметры запроса

В ответ возвращается массив следующего вида:

["opb.applepay","opb.visa","opb.master","opb.mir","opb.googlepay","opb.yandexpay","bspb.visa","bspb.master"]

1	["opb.applepay","opb.visa","opb.master","opb.mir","opb.googlepay","opb.yandexpay","bspb.visa","bspb.master"]