API

Приложение предоставляет REST API для получения списка сформированных форм и полей в них, что позволяет интегрировать приложение со сторонними системами. Для работы с API требуется тариф Профессиональный.

Все запросы к API требуют авторизации с помощью ключа доступа, отображаемого в личном кабинете приложения. Данный ключ должен передаваться в заголовке Authorization запроса.

Основные соглашения:

• все запросы производятся по протоколу HTTPS;
• для передачи данных используется формат JSON, Content-Type: application/json;
• даты передаются в виде unix timestamp в секундах;
• при возврате HTTP-кода >= 400 в теле ответа возвращается объект вида:
  • message - сообщение об ошибке, может отображаться пользователю;
  • data - объект расширенной информации, может быть NULL.

Описание методов

Базовый URL запросов: https://dclubs.ru/evotor/bso/api/3rdparty/

GET /receipt?from=0&to=1000&scheme_uuid=268594e8-92b3-11e7-9176-e41f132ef940

Возвращает список сформированных бланков (чеков) с учетом указанного фильтра.

Параметры

• from - начало периода выборки, включительно, если не задан, то (текущее время - 30 суток) (unix timestamp в секундах);
• to - конец периода выборки, включительно, если не задан, то текущее время (unix timestamp в секундах);
• scheme_uuid - отбор по виду бланков, если не задан, то все виды (UUIDv4).

Ответ

Массив объектов вида:

• uuid - идентификатор бланка (чека);
• device_uuid - идентификатор терминала, сформировавшего бланк;
• bso_number - номер бланка по порядку в рамках терминала;
• period - дата формирования бланка;
• scheme_uuid - идентификатор вида бланка.

GET /receipt/:uuid

Возвращает бланк с идентификатором :uuid.

Ответ

• uuid - идентификатор бланка (чека);
• device_uuid - идентификатор терминала, сформировавшего бланк;
• bso_number - номер бланка по порядку в рамках терминала;
• period - дата формирования бланка;
• scheme_uuid - идентификатор вида бланка;
• fields[] - массив дополнительных полей:
  • uuid - идентификатор поля;
  • name - наименование поля;
  • value - значение поля.

Тут нет нужного мне запроса!

Отправьте информацию о желаемом запросе и его результате нам на почту evotor@soft-c.ru, и мы включим его в план разработки.