Описание API

Версия API 2.0.14, последнее изменение 06.05.2022 15:01 (MSK).

Для работы с API необходимо получить уникальный идентификатор пользователя (USERHASH). Работа с API организуется путём отправки HTTP-запросов на адрес https://booking.mosturflot.ru/api?language=en-US, необходимые параметры передаются методом GET, POST, либо путём загрузки XML-файла с параметрами запроса (в случае загрузки файла, его имя может быть любым, если загружено несколько файлов, будет обработан только первый из них). Обрабатываются только ожидаемые параметры, всё остальное игнорируется. Ответ предоставляется в формате XML либо JSON (формат можно выбрать, установив соответствующий глобальный параметр).

Общие запросы - Список доступных контрагентов

Возвращает список плательщиков, доступных для текущего аккаунта.

Параметры

• test  -  Режим теста. При установке в TRUE будет выведен тестовый список контрагентов (это виртуальные контрагенты, не существующие в реальности). Используется для целей тестирования.
  • Тип: Логический
  • Обязательный: Нет
  • Значение по умолчанию: FALSE

Формат ответа

• createdate  -  Дата и время создания ответа
  • Тип: Дата и время, формат определяется значением глобального параметра DATETIME
  • Обязательный: Да
• version  -  Текущая версия API
  • Тип: Строка
  • Обязательный: Да
• status  -  Результат выполнения запроса. -1 - Ошибка выполнения, 0 - Нет данных, 1 - Выполнен успешно.
  • Тип: Целое число
  • Обязательный: Да
• answer  -  Ответ
  • Тип: Массив данных
  • Обязательный: Да
  • item (элемент массива)  -  Данные контрагента
    • Тип: Набор данных
    • Обязательный: Нет
    • cpid  -  ID контрагента
      • Тип: Целое число
      • Обязательный: Да
    • cpname  -  Название (Ф.И.О.) контрагента
      • Тип: Строка
      • Обязательный: Да
    • cpdocdata  -  Серия и номер документа
      • Тип: Строка
      • Обязательный: Да
    • cpinn  -  ИНН контрагента
      • Тип: Целое число
      • Обязательный: Да
• request  -  Запрос. Содержит массив принятых и использованных для выполнения запроса параметров.
  • Тип: Массив данных
  • Обязательный: Да
• warnings  -  Предупреждения. Содержит массив предупреждений (если есть).
  • Тип: Массив данных
  • Обязательный: Да
• errors  -  Ошибки. Содержит массив ошибок (если есть).
  • Тип: Массив данных
  • Обязательный: Да

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

https://booking.mosturflot.ru/api?language=en-US?userhash=6ab4436ca3aeb1fcbb81a58a9f9d622baa400194&section=global&request=counterparts&test=1

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

<?xml version="1.0" encoding="utf-8"?> <request> <userhash>6ab4436ca3aeb1fcbb81a58a9f9d622baa400194</userhash> <section>global</section> <request>counterparts</request> <test>1</test> </request>

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

<?xml version="1.0" encoding="utf-8"?> <result> <createdate>2025-05-06T14:59:35</createdate> <version>2.0.14</version> <status>1</status> <answer items="3"> <item id="20"> <cpid>20</cpid> <cpname>"Рога и копыта" ООО</cpname> <cpdocdata></cpdocdata> <cpinn></cpinn> </item> <item id="22"> <cpid>22</cpid> <cpname>Иванов Пётр Сидорович</cpname> <cpdocdata></cpdocdata> <cpinn></cpinn> </item> <item id="23"> <cpid>23</cpid> <cpname>Иванова Елена Петровна</cpname> <cpdocdata></cpdocdata> <cpinn></cpinn> </item> </answer> <request> <format>xml</format> <dateformat>msk</dateformat> <userhash>6ab4436ca3aeb1fcbb81a58a9f9d622baa400194</userhash> <section>global</section> <request>counterparts</request> <test>1</test> </request> <errors/> <warnings> <test>Список контрагентов является тестовым и не имеет отношения к реальности.</test> </warnings> </result>

Пример JSON ответа (преобразован в массив)

array ( 'createdate' => '2025-05-06T14:59:35', 'version' => '2.0.14', 'status' => 1, 'answer' => array ( 20 => array ( 'cpid' => 20, 'cpname' => '"Рога и копыта" ООО', 'cpdocdata' => '', 'cpinn' => NULL, ), 22 => array ( 'cpid' => 22, 'cpname' => 'Иванов Пётр Сидорович', 'cpdocdata' => NULL, 'cpinn' => '', ), 23 => array ( 'cpid' => 23, 'cpname' => 'Иванова Елена Петровна', 'cpdocdata' => NULL, 'cpinn' => '', ), ), 'request' => array ( 'format' => 'xml', 'dateformat' => 'msk', 'userhash' => '6ab4436ca3aeb1fcbb81a58a9f9d622baa400194', 'section' => 'global', 'request' => 'counterparts', 'test' => 1, ), 'errors' => array ( ), 'warnings' => array ( 'test' => 'Список контрагентов является тестовым и не имеет отношения к реальности.', ), )