Skip to main content
API поддерживает заголовок X-Request-ID для трассировки запросов. Этот заголовок позволяет связать запросы и ответы в логах и упростить отладку проблем.

​
Описание

X-Request-ID — это опциональный заголовок, который позволяет передать уникальный идентификатор для трассировки запроса. Сервер возвращает этот идентификатор в ответах, что упрощает поиск соответствующих записей в логах.

​
Использование

​
Передача заголовка

Заголовок X-Request-ID передаётся в HTTP-запросе:

​
Формат значения

Значение заголовка — это строка произвольного формата. Рекомендуется использовать UUID для обеспечения глобальной уникальности:

​
Возврат в ответах

Сервер возвращает переданный идентификатор в следующих местах:
  1. В заголовке ответа (для всех запросов):
  2. В теле ответа об ошибке (в поле request_id):

​
Важные особенности

​
Не влияет на логику

Заголовок X-Request-ID не влияет на логику исполнения запроса. Он используется исключительно для трассировки и отладки. Сервер обрабатывает запрос одинаково независимо от наличия или значения этого заголовка.

​
Опциональность

Заголовок является опциональным. Если заголовок не передан, сервер не вернёт его в ответе. Однако рекомендуется всегда передавать X-Request-ID для упрощения отладки.

​
Уникальность

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

​
Использование при обращении в поддержку

При обращении в техническую поддержку всегда указывайте X-Request-ID из запроса, который вызвал проблему. Это позволит быстро найти соответствующие записи в логах сервера и ускорит решение проблемы. Пример обращения: