Портал › Портал документов › Документация API

Служба документов — API

Внутренний HTTP-интерфейс службы документов третьего корпоративного IT-отдела. Используется клиентами синхронизации и модулем выгрузки портала. Все запросы выполняются по HTTPS через корпоративный контур доставки; доступ — только с действующим сеансом, выданным администратором отдела.

Точки входа

GET/portal/api/v1/documents/

Потоковая выдача документа постраничными фрагментами. Клиент синхронизации запрашивает фрагменты последовательно, указывая номер части; ответ отдаётся без буферизации на промежуточных узлах.

Заголовки запроса: X-Portal-Token — токен выгрузки, X-Portal-Session — идентификатор сеанса (hex, 32), X-Part-No — номер фрагмента; сервисный признак запроса передаётся в X-Portal-Meta.
Ответ: 200 OK, тело — двоичный поток фрагмента.
Без сеанса: 401 с описанием ошибки в JSON.

GET/portal/api/v1/documents/export/

Постраничный экспорт архива документов отдела (используется модулем выгрузки). Требует действующего сеанса; без него возвращается ошибка авторизации.

Заголовки запроса: те же, что у потоковой выдачи.
Ответ: 200 OK — страница архива; 401 — нет сеанса.

GET/portal/api/v1/documents

Метаданные списка документов (без выдачи тела). Без действующего сеанса возвращает 401 Unauthorized: invalid session token.

GET/health

Статус службы: {"status":"ok","service":"corp-portal","version":"2.4.1"}.

Документация актуальна для внутреннего контура. Внешний доступ к службе документов возможен только через корпоративный узел доставки; прямые обращения из внешних сетей отклоняются на уровне авторизации. По вопросам выдачи учётных данных и токенов выгрузки — к администратору третьего IT-отдела.