Справочник собран из самого бэкенда: каждый раздел слева — это отдельная OpenAPI-спецификация,
выгруженная из кода, поэтому список эндпоинтов и схемы полей всегда совпадают с тем, что отвечает сервер.
Базовые адреса
Все пути в справочнике указаны от корня — например, POST /v1/auth/login/ на проде это
https://api.yume.cloud/v1/auth/login/. Завершающий слэш обязателен.
Авторизация
API использует JWT. Получите пару токенов по логину и паролю:
В ответе приходят access и refresh. access передаётся в заголовке Authorization каждого последующего запроса — вместе с
X-Tenant-Id, который выбирает компанию (см. ниже).
Когда access истекает, обменяйте refresh на новую пару через POST /v1/auth/refresh/.
refresh-токены ротируются: каждый обмен выдаёт новый refresh, а предыдущий перестаёт работать.
Сохраняйте тот, что пришёл последним.
Выбор компании
Один пользователь может работать в нескольких компаниях, поэтому запрос должен говорить, о какой
идёт речь. Компанию задаёт заголовок X-Tenant-Id — в нём id компании из GET /v1/tenant/:
Заголовок объявлен у каждого эндпоинта в справочнике и необязателен: если его не передать, компания
определяется по домену запроса. Для интеграции, которая ходит на общий api.yume.cloud, передавать
его нужно всегда.
Сервер проверяет, что пользователь действительно состоит в указанной компании. Чужой X-Tenant-Id
не даёт доступа к её данным ни на чтение, ни на запись.
Пагинация
Списочные эндпоинты отдают страницу, а не весь набор:
Страница выбирается параметром page, размер — параметром pageSize (по умолчанию 10, максимум 10000).
Как читать справочник
Разделы слева повторяют деление API на бэкенде, а внутри раздела эндпоинты сгруппированы по ресурсам.
На странице каждого эндпоинта есть параметры, схемы запроса и ответа и примеры кода; поля, помеченные
readOnly, приходят от сервера и не принимаются на запись, writeOnly — наоборот. 
