Запрос позволяет получить информацию о текущей учетной записи. Во многом перекликается с запросами регистрации (w_register_user) и изменения данных пользователя (w_update_user_data).

ID функции

r_profile

Кто может вызывать

Авторизованный пользователь.
Авторизованное приложение.

Принимаемые параметры

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

RUB – российские рубли (по умолчанию);
USD – доллары США;
EUR – евро;
PLN – польские злотые.

fields* – перечень полей, которые нужны клиенту (обязательно указать хотя бы одно):

money_details – подробное состояние счета;
mail – e-mail пользователя;
login – логин;
first_name – имя;
middle_name – отчество;
last_name – фамилия;
nickname – видимое другим людям имя пользователя (никнейм);
phone – номер телефона;
birth_date – дата рождения в ISO-формате «1999-12-21»;
gender – пол;
reviews_cnt – количество рецензий, написанных пользователем и прошедших модерацию;
quotes_cnt – количество цитат (заметок), выделенных пользователем при чтении книг в читалках и приложениях ЛитРес;
biblio – запрос информации о типе учетной записи (с точки зрения библиотечного проекта);
subscr – запрос списка подписок пользователя со статусами;
socnet – запрос информации о социальных сетях, привязанных к учетной записи.
i_follow_cnt – количество пользователей на которых подписан текущий пользователь;
my_followers_cnt – количество пользователей которые подписаны на текущего пользователя;
userpic_ext – расширение аватарки;
profile_approved – одобрен профиль модератором или нет (1 если одобрен, 0 если нет);
profile_privacy – доступность профиля пользователя;
descr – описание пользователя;
books_cnt – количество книг пользователя;
is_megafone_user – является ли пользователь пользователем Мегафона (см. w_paybuyclick_init);
subscr_profit – сумма денег, которую сэкономил пользователь, используя кредитную подписку.
interactions – список токенов-событий со значениями true;

Возвращаемые значения

fields* – массив объектов, содержащий информацию о текущей учетной записи пользователя. Каждый объект содержит вложенный массив объектов с информацией по полям, которые были переданы в запросе:

money_details – подробное состояние счета пользователя (в валюте, переданной в параметрах запроса). Будет включать:
- real – сумма реальных и бонусных (с учетом ограничения на максимальное количество бонусных денег, которое можно потратить при покупке) денег на счету пользователя;
- bonus – сумма бонусных денег на счету пользователя;
- real_money – сумма реальных денег на счету пользователя;
id – внутренний ID пользователя;
mail – e-mail пользователя;
login – логин;
first_name – имя;
middle_name – отчество;
last_name – фамилия;
nickname – видимое другим людям имя пользователя (никнейм);
phone – номер телефона;
birth_date – дата рождения в ISO-виде «1999-12-21»;
gender – пол, может отсутствовать либо принимать значения:
- m – мужчина,
- f – женщина.
reviews_cnt – количество рецензий, написанных пользователем и прошедших модерацию;
quotes_cnt – количество цитат (заметок), выделенных пользователем при чтении книг в читалках или приложениях ЛитРес;
biblio – тип учетной записи. Возможные значения:
- no – учетная запись обычного пользователя (розничный покупатель);
- hide_shop_features – учетная запись школьного читателя, для которого недоступны функции розничной покупки книг.
- mixed – учетная запись, для которой одновременно доступны и функции магазина (покупка) и функции библиотеки. Также может быть подключена к нескольким библиотекам одновременно; Другими словами это любые библиотечные читатели, за исключением школьников.
subscrs – массив, который содержит информацию о подписках пользователя, в том числе их статус. Включает в себя следующие элементы:
- id – ID подписки;
- status – возвращается значение «1», если подписка активна;
- subscr_partner – алиас партнера сервиса подписки;
- host – хост с подписным каталогом, доступный для скачки книг через приложения;
- type – тип подписки: аудио или текстовая;
- valid_till – время, до которого данная подписка активна. Если подписка истекла больше 1 месяца назад, она не будет возвращена методом. Если подписка истекла меньше 1 месяца назад, она вернётся со статусом status=0. Если подписка активна, она вернётся со статусом status=1.
- s_name - локализованное название подписки
- logo_default - логтип по умолчанию (пустое состояние)
- logo_my - логтип для таба в моих книгах
- logo_search - логтип для строки поиска на главной
- logo_read - логотип для кнопки читать по подписке в карточке книги
socnet – перечень социальных сетей, привязанных к учетной записи (см. w_attach_socnet). Каждая социальная сеть будет представлена отдельным элементом:
- fb – Facebook;
- vk – ВКонтакте;
- tw – Twitter.
  Каждая из социальных сетей будет содержать следующие элементы:
  - user_name – имя учетной записи в соцсети;
  - user_id – номер учетной записи в соцсети.
i_follow_cnt – количество пользователей, на которых подписан текущий пользователь;
my_followers_cnt – количество пользователей, которые подписаны на текущего пользователя;
userpic_ext – расширение аватарки;
profile_approved – одобрен профиль модератором или нет (1 если одобрен, 0 если нет);
profile_privacy – доступность профиля пользователя. Может принимать значения:
- default – по умолчанию;
- closed – закрытый;
- public – публичный;
- blocked – заблокирован.
descr – описание пользователя;
books_cnt – количество книг пользователя;
is_megafone_user – является ли пользователь пользователем Мегафона (значение вернется только в случае true). См. w_paybuyclick_init;
subscr_profit – сумма денег, которую сэкономил пользователь, используя кредитную подписку, например – 1839.89.
сurrent_country_2 – текущая страна пользователя, например для России– RU.
сurrent_country_3 – текущая страна пользователя, например для России– RUS.
interactions – объект с токенами-событиями. Например, если пользователь получал триал Литрес.Подписки:
```
"subs14_trial":true
```

Возможные ошибки

error_code

error_message

Описание

101024

Неизвестное поле

Параметр fields содержит недопустимое значение

101073

Указана некорректная валюта

В параметре currency допустимы только следующие валюты:

RUB – российские рубли;
USD – доллары США;
EUR – евро;
PLN – польские злотые.

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

{
  "requests": [
    {
      "func": "r_profile",
      "param": {
        "fields": [
          "money_details",
          "mail",
          "login",
          "first_name",
          "middle_name",
          "last_name",
          "nickname",
          "phone",
          "birth_date",
          "gender",
          "reviews_cnt",
          "quotes_cnt",
          "biblio",
          "subscr",
          "socnet",
          "is_megafone_user",
          "subscr_profit"
        ]
      },
      "id": "r_profile"
    }
  ],
  "time": "2020-05-21T16:49:17+03:00",
  "mobile_app": 1,
  "sid": "5742ck1x4h9t04ezfz8067c7317o",
  "sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c"
}

Пример ответа сервера

{
  "r_profile": {
    "fields": [
      {
        "money_details": {
          "real": "200.0",
          "bonus": "500.0"
        },
        "mail": "my@mail.ru",
        "login": "User",
        "first_name": "Иван",
        "middle_name": "Пертрович",
        "last_name": "Жуков",
        "nickname": "User",
        "phone": "79161234567",
        "birth_date": "1975-12-17",
        "gender": "f",
        "reviews_cnt": "1",
        "quotes_cnt": "22",
        "biblio": "no",
        "is_megafone_user": "1",
        "subscrs": [
          {
            "id": "2",
            "status": "1",
            "subscr_partner": "megafon",
            "valid_till": "2018-07-17T16:21:02+03:00"
          },
          {
            "id": "3",
            "subscr_partner": "megafon_audio",
            "valid_till": "2018-07-16T16:21:02+03:00"
          }
        ],
        "socnet": {
          "tw": {
            "user_id": "123271211",
            "user_name": "VasyaPupkin"
          },
          "vk": {
            "user_id": "216132106",
            "user_name": "Pupkin"
          },
          "fb": {
            "user_id": "100001123574100",
            "user_name": "Vasya"
          }
        },
        "subscr_profit": "1839.89"
      }
    ],
    "success": true
  },
  "success": true,
  "time": "2020-05-21T16:49:26+03:00"
}