ИДЕНТИФИКАЦИЯ

Идентификация запросов

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

Пример заголовка x-trace-id:

curl -X 'GET' \
  'https://your-org.domain/public-api/eps' \
  -H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
  -H 'Authorization: client-text-token' \
  -H 'x-trace-id: 09b9b69c-68cf-4f44-ba0a-180398d71da0' \
  -H 'x-version: 409' \
  -H 'x-tenant-id: 3fa85f64-5717-4562-b3fc-2c963f66afa6'
'

Идентификация пространства

Все данные предприятия или пользователя привязаны к определенному пространству, для того, что бы получить данные из системы PLAN-R, кроме пользовательского токена, в заголовке x-tenant-id HTTP запроса следует указать ID пространства, для которого Вы запрашиваете данные.

Пример заголовка x-tenant-id:

curl -X 'GET' \
  'https://your-org.domain/public-api/eps' \
  -H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
  -H 'Authorization: client-text-token' \
  -H 'x-tenant-id: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -H 'x-version: 409' \
  -H 'x-trace-id: 09b9b69c-68cf-4f44-ba0a-180398d71da0'
'

Как узнать ID пространства

Уникальный идентификатор пространства можно посмотреть в Web консоли администрирования в разделе «Пространства». Выберите в списке пространство, для которого хотите посмотреть идентификатор, щелкните по нему два раза и скопируйте идентификатор из открывшегося окна.