api/v2/ОбщиеПараметрыОтвета

Общие параметры ответа

Каждый ответ от сервера содержит набор параметров, которые указываются в ответе вне зависимости от типа запроса. Данный документ описывает эти параметры.

Формат:

   1 <?xml version="1.0"?>
   2 <response>
   3  <datetime></datetime>
   4  <code></code>
   5  <code_desc></code_desc>
   6  <sign></sign>
   7  ...
   8 </response>

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

Название	Описание	Примечание
datetime	Штамп времени ответа сервера	В формате iso8601.
code	Код ответа	См. справочник кодов ответа
code_desc	Описание кода ответа	См. справочник кодов ответа
sign	Подпись ответа	Представляет из себя значение хэша функции bcrypt от склееной строки: `ключ для доступа к API пользователя` + значение `datetime` ответа + значение `code` ответа + `количество записей ответа`. Количеством записей ответа считается количество тегов-потомков первого уровня в теге, характеризующем ответ. Данный тег отсутствует, если ошибка при разборе запроса связана с разбором синтаксиса или неверными авторизационными данными, так как в этом случае сервер masspayer не знает какой пользователь отправил запрос.

Пример

При запросе валют пользователем с секретным ключом API secret_api_key могут быть выданы следующие ответы: При неверной авторизации:

   1 <?xml version="1.0"?>
   2 <response>
   3  <datetime>2014-10-13T09:27:12.585300+04:00</datetime>
   4  <code>3</code>
   5  <code_desc>Ошибка авторизации</code_desc>
   6 </response>

При верной авторизации:

   1 <?xml version="1.0"?>
   2 <response>
   3  <datetime>2014-10-13T09:27:12.585300+04:00</datetime>
   4  <code>0</code>
   5  <code_desc>Ошибки нет</code_desc>
   6  <sign>$2a$10$F7SEfh/GMSQOXohk/uEYGO5pTwjUQv9mikDONQadLSzjGuyfhOgyK</sign>
   7  <currency_list>
   8   <currency id="1">
   9    <code>RUR</code>
  10    <desc>Российский рубль</desc>
  11   </currency>
  12   <currency id="2">
  13    <code>USD</code>
  14    <desc>Американский доллар</desc>
  15   </currency>
  16  </currency_list>
  17 </response>

Подпись получена как: хэш bcrypt от строки secret_api_key2014-10-13T09:27:12.585300+04:0002 с добавлением соли $2a$10$F7SEfh/GMSQOXohk/uEYGO. Последний параметр, склеиваемый в строке подписи равен 2, так как тегом, характеризующим ответ, является тег currency_list и он насчитывает 2 записи currency.

ВНИМАНИЕ! Рекомендуется проверять значение подписи ответа на своей стороне, дабы удостовериться, что ответ был послан именно сервером masspayer.

КатегорияApiV2