API 1С УПП

HTTP API к данным 1С УПП через gateway. Методы отдают документы, справочники и остатки в JSON; запись в 1С через этот API не выполняется.

Полный перечень — в разделе Список методов. Подключение и авторизация — на странице Авторизация, стенды — в Окружениях.

Как устроены вызовы

  • Метод HTTP: GET
  • Путь: /main/hs/<сервис>/<действие> (см. страницу конкретного метода)
  • Параметры: query string, все опциональны; читаются из URL и query
  • Авторизация: HTTP Basic, пара Пользователь / Пароль (см. Авторизация)
  • Проверка доступности: HealthGET /main/hs/health

Полный URL: {Base URL}{путь метода}. Base URL — домен или поддомен, привязанный через DNS к серверу с опубликованной базой 1С; выдаёт администратор 1С УПП и в документации не публикуется (подробнее — Авторизация).

Формат ответа

Большинство методов возвращают JSON:

{
  "data": [],
  "errors": []
}
ПолеОписание
dataРезультат: массив, дерево или объект в зависимости от метода
errorsСообщения об ошибках валидации параметров или обработки отдельных записей

Массив errors при HTTP 200 не означает полный провал: в data могут быть успешно обработанные записи.

Непредвиденная ошибка на стороне 1С — 500 с телом { "error": "..." }. Исключение — Health: при 500 тело plain text.

Content-Type успешного ответа: application/json; charset=utf-8.

Параметр full

У части методов есть флаг full (1, true, yes, да): вместо сводки возвращаются полные табличные части, договоры или детализация остатков. Условия срабатывания и обязательные сочетания с другими параметрами — на странице каждого метода.

Фильтрация и даты

  • Текстовые фильтры (code, name, warehouse и т.д.) — поиск ПОДОБНО, подстрока в поле.
  • Периоды from / to и одиночная date — форматы ДД.ММ.ГГГГ, ГГГГ-ММ-ДД, ДД-ММ-ГГГГ.
  • В name и material символ / в query передаётся как _slash_.

Что доступно через API

HTTP-коды

КодКогдаТело
200Запрос обработан{ "data": [...], "errors": [...] } или { "Статус": "..." } (Health)
401Нет или неверная авторизацияот gateway / 1С
500Сбой на стороне 1С{ "error": "..." } или plain text (Health)