Различия

Здесь показаны различия между выбранной ревизией и текущей версией данной страницы.

Ссылка на это сравнение

bonussystemapi:api [06.12.2018 17:37]
Андрей Черных [Методы]
bonussystemapi:api [21.08.2019 16:26] (текущий)
Маргарита Есина [Методы]
Строка 86: Строка 86:
         "​cards":​ [         "​cards":​ [
           {           {
-            "cardnum": "​card1",​+            "masked_card": "​card1",​
             "​balance":​ 123.19             "​balance":​ 123.19
           },           },
           {           {
-            "cardnum": "​card2",​+            "masked_card": "​card2",​
             "​balance":​ 513.84             "​balance":​ 513.84
           }           }
Строка 98: Строка 98:
         "​cards":​ [         "​cards":​ [
           {           {
-            "cardnum": "​card1",​+            "masked_card": "​card1",​
             "​balance":​ 15187.48             "​balance":​ 15187.48
           }           }
Строка 108: Строка 108:
 </​code>​ </​code>​
  
-На верхнем уровне находится поле result, в котором находится список с id пользователей бонусной системы,​ указанных в параметре "​ids"​. В объекте cards пользователя содержится список его карт. Значением поля ​cardnum ​является номер его карты, значением поля balance - значение баланса. Поле balance может не быть, в случае,​ если оно не указано в параметре scope запроса.+На верхнем уровне находится поле result, в котором находится список с id пользователей бонусной системы,​ указанных в параметре "​ids"​. В объекте cards пользователя содержится список его карт. Значением поля ​masked_card ​является номер его карты, значением поля balance - значение баланса.
  
-В ответе будут только те пользователи, которые зарегистрированы в бонусной системе. ​Передача ID пользователей, которых нет в базе, вернет пустой словарь в result.+В ответе будет присутствовать информация ​только по тем картам, которые зарегистрированы в бонусной системе. 
 + 
 +Запрос информации по карте по ID пользователя, которого ​нет в базе, вернёт пустое значение параметра ​result.
  
 В случае,​ если запрос выполнился с ошибкой,​ её описание будет доступно по ключу error. В случае,​ если запрос выполнился с ошибкой,​ её описание будет доступно по ключу error.
 +
 +
 +=== Получение кэшбэка системы ===
 +== Запрос ==
 +//​Метод:​ getsystemfee//​
 +
 +Путь запроса:​ /​api/​getinfo. ​
 +В теле запроса необходимо указать следующие параметры:​
 +
 +^ Название параметра ^ Тип поля ^ Описание ^ Обязательность ^ Значение по умолчанию ^
 +|method |строка |Название вызываемого метода | Да |- |
 +|refund |число |1 - учитывать транзакции покупок и возвратов,​ 0 учитывать только транзакции покупок | Да |- |
 +|tsp |список |Список номеров ТСП, по которым вернуть размер кэшбэка системы (id - строка,​ число) | Нет |[] |
 +|from |строка |Дата начала выборки транзакций в формате гггг-мм-дд (включая указанную дату) | Нет | - |
 +|to |строка |Дата окончания выборки транзакций в формате гггг-мм-дд (не включая указанную дату) | Нет | - |
 +|version |строка |Версия API | Нет | latest |
 +
 +
 +Пример запроса:​
 +<​code>​
 +POST /​api/​getinfo
 +Content-Encoding:​ UTF-8
 +Content-Type:​ application/​json
 +BS-sid: 0
 +BS-key: somekey
 +
 +{
 +  "​method":​ "​getsystemfee",​
 +    "​refund":​0,​
 +    "​tsp":​ [
 +    "​id1",​
 +    "​id2"​
 +  ],
 +    "​from":"​2019-05-06",​
 +    "​to":"​2019-05-11"​
 +}
 +</​code>​
 +
 +== Ответ ==
 +В теле ответа содержится JSON-сериализованная информация о транзакциях с кэшбэком системы. Пример JSON ответа:​
 +<​code>​
 +{
 +  "​result":​ {
 +      <id пользователя 1>: {
 +         <​id транзакции 1>: {
 +            "​sum":​ "​1.00",​
 +            "​cashback":​ "​0.06",​
 +            "​tsp":​ "​ООО ТСП 1",
 +            "​date":​ "​2019-05-06 12:​33:​30"​
 +          },
 +          <id транзакции 2>: {
 +            "​sum":​ "​10.00",​
 +            "​cashback":​ "​0.6",​
 +            "​tsp":​ "​ООО ТСП 2",
 +            "​date":​ "​2019-05-08 11:​17:​35"​
 +          },
 +      },
 +      <id пользователя 2>: {
 +        <id транзакции 8>: { ... }
 +      }  ​
 +      },
 +  "​error":​ null
 +}
 +</​code>​
 +
 +
 +На верхнем уровне находится поле result, в котором содержатся словари с ключами - номерами участников в системе. В каждом словаре с ключом-номером участника,​ содержатся вложенные словари транзакций,​ ключ которых - идентификатор транзакции,​ а в значении - словарь со следующими параметрами:​
 +  * "​sum"​ - сумма транзакции в рублях,​ при возврате,​ отрицательная
 +  * "​cashback"​ - кэшбэк системы в рублях,​ при возврате,​ отрицательный
 +  * "​tsp"​ - наименование ТСП
 +  * "​date"​ - дата транзакции в формате "​гггг-мм-дд чч:​мм:​сс"​
 +
 +Если ключ словаря с транзакциями null, то транзакции совершены по непривязанной карте, выпущенной для бонусной системы.
 +
 +В ответе будет присутствовать информация только по тем ТСП, которые зарегистрированы в бонусной системе.
 +
 +Запрос по ТСП, которых нет в базе, вернет пустые значения в параметрах result и error.
 +
 +В случае,​ если запрос выполнился с ошибкой,​ её описание будет доступно по ключу error. ​
 +