АЗС-Онлайн Гарвекс: как подготовить пример ошибки отчёта для поддержки

Зачем поддержке пример ошибки

Сообщения «отчёт неверный» недостаточно, чтобы понять, где возникло расхождение. Для проверки важно описать, какой результат вы ожидали, что получили фактически и при каких параметрах сформировали выборку. Тогда проблему можно рассматривать на конкретном примере, а не по общему описанию.

Соберите данные по одному отчёту и одному периоду. Не нужно отправлять всю историю операций: достаточно небольшого фрагмента, который показывает несоответствие. Если ошибка повторяется, отметьте это и укажите, при каких условиях она появляется.

АЗС-Онлайн позволяет выгружать данные через API. В документации описаны REST-взаимодействие, формат JSON и фильтрация событий по датам, колонке, фирме и номеру заправки. Для примера ошибки полезно зафиксировать те параметры, которые использовались при получении данных.

Что записать перед обращением

Подготовьте краткую карточку проблемы:

• Какой отчёт или данные проверяете. Укажите название раздела либо опишите, что именно выгружали: события, заправки или пополнения резервуара.
• Период выборки. Запишите начало и окончание периода с датой и временем, если они задавались. Не заменяйте точные границы словами «за вчера» или «за неделю».
• Фильтры. Отметьте, выбирали ли конкретную колонку, фирму, резервуар или номер заправки. Если фильтр не задавали, так и укажите.
• Ожидаемый результат. Например: «В выборке должна быть запись, которую я вижу в исходных данных». Поясните, на чём основано ожидание.
• Фактический результат. Запишите, что именно не совпало: запись отсутствует, значение отличается или период отображается не так, как ожидалось.
• Повторяемость. Укажите, возникает ли проблема при повторной выгрузке с теми же параметрами.
• Пример записи. Если он доступен, приложите минимальный фрагмент, по которому видно расхождение.

Отделяйте наблюдение от предположения. Формулировка «в выборке за указанный период нет ожидаемой записи» описывает факт. Версия «сбой вызвала колонка» — это гипотеза, если её отдельно не проверяли.

Как зафиксировать параметры отчёта

Для событий в документации API предусмотрены даты начала и окончания отчёта, а также необязательные фильтры по ID колонки, фирме и номеру заправки. Есть параметр, который позволяет выбрать заправки, системные события либо оба типа событий. Если данные получали через API, скопируйте значения параметров запроса в обращение — без логина, пароля и других секретов доступа.

Для журнала пополнений резервуара важно указать ID резервуара и период. В ответе такого запроса могут присутствовать дата пополнения или корректировки, значение, название резервуара и комментарий. При сверке сопоставляйте одинаковые объекты и границы периода: иначе две выборки могут различаться не из-за ошибки, а из-за разных условий отбора.

Если проверяете выгрузку топлива, приложите только необходимые строки и поясните, с чем именно их сравниваете. Например, укажите, что один и тот же период и объект выбраны в обоих источниках. Не объединяйте в одном примере события по разным резервуарам или колонкам, если это затрудняет проверку.

Подробнее о возможностях сервиса можно прочитать на странице АЗС-Онлайн.

Безопасный пример для проверки

Перед отправкой проверьте, что в материалах нет паролей, токенов, данных для входа и лишней персональной информации. Если в примере есть сведения, не нужные для разбора ошибки, скройте их. При этом оставьте видимыми параметры, которые позволяют понять суть расхождения: даты, выбранный фильтр и значения, относящиеся к проблемной записи.

Не редактируйте исходный файл так, чтобы изменились сами спорные значения. Если подготовили обезличенную копию или скриншот, сохраните исходный пример отдельно: так можно будет уточнить детали, если потребуется. В сообщении обозначьте, какие данные скрыты.

Для API достаточно описать использованный метод, период и значения фильтров, а также приложить небольшой фрагмент запроса и ответа после удаления секретов. Документация указывает, что взаимодействие использует HTTPS, а данные передаются в формате JSON; доступ к API требует действующих учётных данных. Поэтому не отправляйте пароль вместе с примером и не публикуйте его в открытом виде.

Шаблон описания ошибки

Скопируйте заготовку и заполните только подходящие пункты:

Что проверяю:
Способ получения данных: интерфейс / API
Период:
Объект и фильтры:
Ожидаемый результат:
Фактический результат:
Повторяется ли при тех же условиях:
Пример записи или фрагмент ответа:
Какие сведения скрыты:

Если формировали запрос к API, отдельно укажите параметры дат и применённые фильтры. Для событий документация описывает поля начала и окончания периода, ID колонки, фирмы и номер заправки. Для пополнений резервуара укажите его ID и временные границы выборки. Не добавляйте параметры, которые не использовали: это поможет сохранить точность описания.

Перед отправкой

Сверьте, что пример относится к одному периоду и одному набору фильтров. Убедитесь, что фактическое расхождение понятно без догадок, а вложение не содержит паролей и ненужных данных. Если сравниваете две выгрузки, подпишите, откуда каждая получена и какие условия отбора применялись.

Документы и руководства Гарвекс размещены в разделе документации. Если нужна помощь с подготовкой обращения по АЗС-Онлайн, можно связаться с компанией и приложить собранный пример. Такой формат не гарантирует заранее конкретный результат проверки, но помогает точнее понять, что именно требуется разобрать.

Вывод

Для обращения по ошибке отчёта подготовьте точный период, фильтры, ожидаемый и фактический результат и небольшой фрагмент данных. При сверке выгрузки топлива сравнивайте одинаковые объекты и условия отбора. Удалите секреты доступа и скройте лишние сведения — после этого можно отправить пример вместе с описанием проблемы.