Получение данных об учетной записи

Данная команда позволяет получить информацию о состоянии своей учетной записи. Ее использование может быть полезным, например, если необходимо узнать текущий баланс на лицевом счете учетной записи без посещения личного кабинета на сайте сервиса ahunter.ru.

Параметры команды

Обязательные параметры для выполнения запроса.

  • https://ahunter.ru/site/user/account/get - URL-команды.
  • user=API-токен - API-токен пользователя из личного кабинета.
  • output=json - данный параметр сообщает сервису формат, в котором требуется вернуть результат обработки. В отличие от команд стандартизации данных, данная команда поддерживает только JSON формат.

Опциональные параметры.

  • output=pretty - опция применима только в случае использования JSON формата ответа сервиса. Данная опция требует, чтобы сервис выполнил "красивое" форматирование возвращаемого JSON текста, расставив в нем переносы строк, отступы и пробельное прореживание. Опция может быть полезна при отладке взаимодействия пользовательского приложения с сервисом.

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

Ниже приведен пример данного запроса сервису.

https://ahunter.ru/site/user/account/get?user=demotoken;output=json|pretty

В данном запросе используются следующие параметры.

  • user=demotoken - сообщает сервису API-токен пользователя.
  • output=json|pretty - сообщает сервису о том, что необходимо вернуть ответ в формате JSON, отформатировав его "красиво".

Результат запроса в формате JSON

Ниже приведен пример ответа сервиса. Результирующий JSON-ответ получен с использованием опции output=json|pretty, позволяющей выполнить "красивое" форматирование JSON-текста.

    {
      "actual_sum" : 7500,
      "create_time" : "2015-05-07T19:59:37.013Z",
      "modification_time" : "2015-12-22T21:47:35.150Z",
      "name" : "user",
      "mail" : "user@mail.ru",
      "person_name" : "Иванов Иван Иванович",
      "token_api" : "demotoken",
      "type" : 1,
      "last_debit" : {
        "debit_type" : 2,
        "id" : 1154,
        "sum" : 5,
        "time" : "2015-12-25T13:57:58.746Z"
      },
      "last_payment" : {
        "id" : 12,
        "order_id" : 9,
        "source" : "ym",
        "sum" : 10000,
        "time" : "2015-12-22T15:54:52.713Z"
      },
      "request_process_time" : 0
    }

Результатом выполнения данной команды является JSON-объект со следующими элементами.

  • actual_sum - целое число денежных средств в копейках, доступных в настоящий момент на счете пользователя.
  • create_time - строка, содержащая дату и время создания учетной записи пользователя в формате XML Scheme dateTime (http://www.w3.org/TR/xmlschema-2/#dateTime).
  • modification_time - строка, содержащая дату и время модификации учетной записи пользователя в формате XML Schema dateTime (http://www.w3.org/TR/xmlschema-2/#dateTime).
  • name - строка, содержащая имя учетной записи пользователя.
  • mail - строка, содержащая почтовый ящик пользователя, указанный при регистрации.
  • person_name - строка, содержащая персональное имя пользователя (например, полное ФИО), указанное при регистрации.
  • token_api - строка, содержащая токен API пользователя.
  • type - число, обозначающее тип учетной записи пользователя. Значение 1 соответствует Стандартной учетной записи, значение 2 соответствует Партнерской учетной записи.
  • last_debit - JSON-объект, содержащий информацию об операции последнего списания денежных средств со счета пользователя.
  • last_payment - JSON-объект, содержащий информацию об операции последнего пополнения денежных средств на счете пользователя.
  • request_process_time - время обработки всего запроса в целом в миллисекундах.

Ниже приведено детальное описание этих элементов.

JSON-объект last_debit

Данный объект содержит сведения о последней операции списания денежных средств с лицевого счета пользователя. Пример такого объекта приведен ниже.

      {
        "debit_type" : 2,
        "id" : 1154,
        "sum" : 5,
        "time" : "2015-12-25T13:57:58.746Z"
      }

Данный объект содержит следующие элементы.

  • debit_type - элемент числового типа, он содержит тип операции, за которую было выполнено последнее списание денег. Значение 1 соответствует операции списания за обработку файла-реестра в разделе Реестры личного кабинета. Значение 2 соответствует операции списания за обработку порции API-запросов.
  • id - элемент числового типа, он содержит уникальный идентификатор выполненной операции списания.
  • sum - элемент числового типа, содержащий сумму списанных денег в копейках.
  • time - строка, содержащая дату и время выполнения операции списания в формате XML Schema dateTime.

JSON-объект last_payment

Данный объект содержит сведения о последней операции пополнения денежных средств на лицевом счете пользователя. Пример такого объекта приведен ниже.

      {
        "id" : 12,
        "order_id" : 9,
        "source" : "ym",
        "sum" : 10000,
        "time" : "2015-12-22T15:54:52.713Z"
      }

Данный объект содержит следующие элементы.

  • id - элемент числового типа, он содержит уникальный идентификатор выполненной операции пополнения.
  • order_id - идентификатор платежа в рамках платежной системы, используемой для пополнения счета.
  • source - строковое сокращенное название платежной системы.
  • sum - элемент числового типа, содержащий сумму платежа.
  • time - строка, содержащая дату и время выполнения платежа в формате XML Schema dateTime.
версия сервиса:
© ixLab, 2007-2017, e-mail: info@ixlab.ru
обработано за 1 (мс)