HTML-генератор отчётов

Генерация HTML-файла
Скачивание HTML-файла
Просмотр HTML-файла

HTML-generator позволяет получать отчёты B2BAPI в формате HTML-страницы.

Для визуального оформления используются фиксированные шаблоны отчётов. Чтобы определить и согласовать требования к стилю отчётов и получить идентификатор шаблона, обратитесь к вашему менеджеру.

Базовый URL:

https://report-html.spectrumdata.ru

Аутентификация запросов

Каждый запрос к API должен содержать HTTP-заголовок Authorization со значением AR-REST {token}:

Authorization: AR-REST test_token

Генерация HTML-файла

Чтобы сформировать HTML-версию отчёта, отправьте POST-запрос к /api/v2/reports/{reportUid}/html.

Параметры строки запроса

Параметр	Тип	Обязательность	Описание
`reportUid`	string	Обязательный	UID отчёта, полученный при генерации в B2BAPI

Параметры тела запроса

Параметр	Тип	Обязательность	Описание
`template_uid`	string	Обязательный	UID шаблона для оформления

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

curl -X POST 'https://report-html.spectrumdata.ru/api/v2/reports/test_report@test_domain/html' \
--header 'Content-Type: application/json' \
--header 'Authorization: AR-REST test_token' \
--data-raw '{
  "template_uid": "test_template@test_domain"
}'

Генерация может занять несколько секунд в зависимости от размера отчёта. Файлы хранятся 30 дней.

Ответ API содержит ссылку для скачивания сгенерированного файла и его идентификатор в хранилище сервиса.

Структура ответа

Поле	Тип	Описание
`link`	string	URL для скачивания файла
`file_uid`	string	UID файла

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

{
  "link": "https://s3.spectrumdata.ru/reports/test_report%40test_domain%40test_file.html",
  "file_uid": "test_report@test_domain@test_file"
}

Скачивание файла отчёта

Чтобы скачать сгенерированный HTML-файл отчёта из хранилища, отправьте GET-запрос к /api/v2/files/{fileUid}/download.

Параметры строки запроса

Параметр	Тип	Обязательность	Описание
`fileUid`	string	Обязательный	UID файла, который был получен при его генерации

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

curl 'https://report-html.spectrumdata.ru/api/v2/files/test_report@test_domain@file_uid/download'
--header 'Authorization: AR-REST test_token' \

Ответ API содержит HTML-файл отчёта с заголовком Content-Disposition: attachment для автоматического скачивания файла браузером.

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

Content-Disposition: attachment;
filename="test_report@test_domain@test_file.html"

Просмотр сгенерированного HTML-файла в браузере

Для открытия отчёта в браузере отправьте GET-запрос к /api/v2/files/{fileUid}/open.

Параметры строки запроса

Параметр	Тип	Обязательность	Описание
`fileUid`	string	Обязательный	UID файла, который был получен при его генерации

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

curl 'https://report-html.spectrumdata.ru/api/v2/files/test_report@test_domain@test_file/open'
--header 'Authorization: AR-REST test_token' \

Ответ API содержит HTML-код страницы отчёта.