Запуск workflow через API

Как вызвать опубликованный процесс HTTP-запросом, где взять адрес и токен и как передать значения параметров.

Опубликованный процесс можно вызвать из своего кода: так workflow встраивается в чужой конвейер, запускается из приложения или из планировщика, который у вас уже есть.

Точки доступа API Workflow

Где взять адрес

Раздел Разработчикам → Точки доступа API Workflow перечисляет процессы, которые разрешено вызывать через API. Кнопка «Скопировать URL-адрес API» кладёт в буфер готовый адрес вызова.

Тот же адрес есть в самом редакторе — в меню кнопки публикации, командой «Просмотреть триггеры».

Если процесса в списке нет, он не опубликован. Опубликуйте его, и он появится.

Как вызвать

Вызов идёт на конечную точку SQL-задания той связи, с которой работает процесс:

POST {базовый адрес API}/v3/sql/{подключение}/job

Тело запроса — JSON с двумя полями: query с вызовом процедуры процесса и queryParameters со значениями параметров.

curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ВАШ_ТОКЕН' \
     -d '{"query": "CALL wf_отчёт_по_продажам(@dateFrom, @dateTo)",
          "queryParameters": {"dateFrom": "2026-09-01", "dateTo": "2026-09-30"}}' \
     -X POST \
     https://workspace.epsilonmetrics.ru/api/v3/sql/epsilon_dw/job

Тот же вызов можно сделать методом GET, передав query, queryParameters и access_token в адресной строке. Так удобно проверять на скорую руку, но для рабочего кода лучше POST: токен не попадает ни в журналы сервера, ни в историю браузера.

Готовые заготовки обоих вызовов — с подставленными именем процедуры, параметрами и токеном — показывает диалог по кнопке «Скопировать URL-адрес API»: их достаточно скопировать и подставить свои значения.

Параметры

В вызове участвуют не все переменные процесса, а только отмеченные флажком Параметр — см. Переменные. Порядок аргументов в CALL совпадает с порядком переменных в панели процесса, поэтому, меняя порядок, не забудьте поправить вызывающий код.

Переменные без этого флажка всегда берут значение по умолчанию, снаружи их не переопределить.

Токен

Вызов авторизуется токеном доступа к API. Он создаётся в разделе Разработчикам → Учётные данные и действует, пока его не удалят.

Токен можно ограничить: списком разрешённых API, доступом к конкретным подключениям и списком сайтов, с которых разрешены обращения. Для вызова процессов достаточно доступа к SQL API и к тому подключению, с которым работает процесс.

Токен — секрет: он даёт те же права, что и учётная запись, которая его создала. Храните его в хранилище секретов, а не в исходном коде, и заведите отдельный токен на каждую интегрируемую систему, чтобы отзыв одного не ломал остальные.

Что вернётся

Ответ содержит результат выполнения процесса. Если процесс завершился ошибкой, вызов вернёт её описание — то же, что видно в ленте запусков.

Запуски через API попадают в ленту наравне с остальными, поэтому разбирать их можно тем же способом: открыть историю процесса и посмотреть данные шагов.

Когда лучше вебхук

Вызов через API и триггер «Вебхук» решают похожие задачи, но по-разному.

API вызывают, когда внешняя система готова авторизоваться токеном и дождаться результата. Это способ для своего кода.

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