04-nastrojki

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

Источник: https://docs.paykeeper.ru/dokumentatsiya-json-api/nastrojki/

Запросы на получение информации о пользователях, организации и настройках системы.

Список запросов

Информация о пользователе

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/	Список email-адресов для оповещений
4.7 /info/organization/users/	Список пользователей
4.8 /info/organization/enabledbuttons/	Включённые кнопки платёжных систем

---

4.1 Настройки пользователя /info/user/settings/

Тип: GET
Формат: /info/user/settings/

Параметры ответа:

Параметр	Назначение
id	ID пользователя
login	Логин
refund	Дневной лимит возвратов
admin	Признак администратора (true/false)
invoices_only	Доступ только к счетам
email	Email
refund_allow	Разрешены ли возвраты

Пример:

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

---

4.2 Последний вход /info/user/lastvisit/

Тип: GET
Формат: /info/user/lastvisit/

Параметры ответа:

Параметр	Назначение
ip	IP-адрес
datetime	Дата/время

Пример:

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

---

4.3 Настройки организации /info/organization/settings/

Тип: GET
Формат: /info/organization/settings/

Параметры ответа:

#	Параметр	Назначение	Для кого
1	shopname	Название магазина	Все
2	shopdomain	URL сайта магазина	Все
3	legal_name	Юридическое название организации	Все
4	paykeeper_id	Номер договора	Все
5	support_email	Email службы поддержки	Admin
6	informer_type	Режим оповещения (post/email)	Admin
7	informer_url	URL для POST-оповещений	Admin
8	informer_seed	Секретное слово для подписи	Admin
9	smtp_use_custom	Флаг кастомного SMTP	Admin
10	smtp_host	SMTP host	Admin
11	smtp_port	SMTP port	Admin
12	smtp_user	SMTP пользователь (email)	Admin
13	smtp_password	SMTP пароль	Admin
14	skip_default_pages	Пропускать страницы PayKeeper	Admin
15	success_url	URL успеха	Admin
16	fail_url	URL ошибки	Admin
17	cabinet	Флаги видимости вкладок/кнопок	Все
18	currency	Валюта по умолчанию	Все
19	email	Email текущего пользователя	Все

Пример:

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

---

4.4 Информационные сообщения /info/organization/notifications/

Тип: GET
Формат: /info/organization/notifications/

Параметры ответа:

Параметр	Назначение
type	Тип (important, bottom, bottom_important)
message	HTML-текст
link	URL (href)
link_caption	Текст ссылки

Пример:

[
   {
      "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
Формат: /info/organization/fields/

Параметры ответа:

Параметр	Назначение
pk_name	Имя поля в PayKeeper
displayed_name	Отображаемое имя
required	Обязательность (true/false)
placeholder	Значение по умолчанию
enabled	Активно (true/false)
type	Тип: sum, text, phone, email, bool, clientid, orderid
order	Порядок (0-10000, по возрастанию)

Пример:

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

---

4.6 Email-адреса для оповещений /info/organization/reportemails/

Тип: GET
Формат: /info/organization/reportemails/

Параметры ответа:

Параметр	Назначение
id	ID
email	Email

Пример:

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

---

4.7 Пользователи организации /info/organization/users/

Тип: GET
Формат: /info/organization/users/

Параметры ответа: как в 4.1 (массив).

Пример:

[
  {
    "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/

Пример:

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