# Запуск шаблона через API

Продолжайте в том же сеансе Bash и рабочем каталоге, что и в [быстром старте](/ru/browser-rpa/quickstart). Сначала убедитесь, что клиент поддерживает операции, которые используются на этой странице:

```bash
jq -e '.data.operations as $ops | ["validateWorkflow","startRun","getRun","listRunNodes","listRunArtifacts"] - $ops | length == 0' capabilities.json
```

Выберите профиль браузера Chromium. ID окружения совпадает с `envId` профиля. Если вы знаете только имя профиля, найдите его с помощью `ml-cli env find --keyword <keyword>` или `POST /api/env/page` в [Local API профилей браузера](/ru/api-reference/browser/local-api) и устраните любую неоднозначность до запуска. Чтобы подтвердить тип браузера, убедитесь, что `POST /api/env/detail` возвращает `browserTypeId: 1`. Передавайте ID строкой. Позиции в списке и порты отладки не являются ID профилей.

## 1. Выполните предварительную проверку сохранённой версии

Для предварительной проверки и запуска используйте одни и те же ID шаблона, версию, окружение и параметры. Передавайте значение каждого параметра в виде `{kind:"json",value:...}`. Приватные параметры отправляются открытым текстом, а файловые параметры принимают абсолютные локальные пути (для нескольких файлов передайте массив). В этом примере приватных параметров нет. Продолжайте, только если отчёт о проверке показывает `valid: true` и не усечён. Если профиль занят, дождитесь, пока предыдущий запуск снимет изоляцию.

```bash
: "${RPA_ENVIRONMENT_ID:?Set the actual Chromium profile ID first}"
jq --arg env "$RPA_ENVIRONMENT_ID" '
  .data | {templateId:.id,version,environmentId:$env,
    parameters:{targetUrl:{kind:"json",value:"https://example.com"}}}
' created.json > start-run.json &&
jq '{purpose:"run",source:{kind:"template",templateId,version},
    environmentId,parameters}' start-run.json > validate-run.json &&
rpa_curl "$RPA_BASE_URL/validations" -H 'Content-Type: application/json' --data-binary @validate-run.json -o validation-run.json &&
jq '.data | {valid,issues,truncated,runtimeChecks}' validation-run.json &&
jq -e '.data.valid == true and .data.truncated == false' validation-run.json
```

## 2. Начните запуск

```bash
([ -s run.key ] || uuidgen > run.key) &&
rpa_curl "$RPA_BASE_URL/runs" \
  -H 'Content-Type: application/json' \
  -H "X-RPA-Catalog-Revision: $RPA_CATALOG_REVISION" \
  -H "Idempotency-Key: $(cat run.key)" \
  --data-binary @start-run.json -o started.json &&
RPA_RUN_ID="$(jq -er '.data.id' started.json)" &&
jq '.data | {id,status,template}' started.json
```

HTTP 202 означает, что запуск зарегистрирован, но ещё не завершён. Сохраните ID запуска, исходный ключ и замороженную ревизию шаблона. Тайм-аут на транспортном уровне не отменяет запуск: прежде чем отправлять новый запрос на запись, выполните [восстановление запроса](/ru/browser-rpa/local-api#%D0%B2%D0%BE%D1%81%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5).

## 3. Дождитесь конечного состояния

```bash
for attempt in $(seq 1 100); do
  rpa_curl "$RPA_BASE_URL/runs/$RPA_RUN_ID" -o run-detail.json || break
  status="$(jq -r '.data.run.status' run-detail.json)"
  echo "status: $status"
  case "$status" in
    success|failed|cancelled|stopped|missed) break ;;
    queued) sleep 5 ;;
    *) sleep 3 ;;
  esac
done
```

Цикл проверяет активный запуск каждые 3 секунды, а запуск в очереди каждые 5 секунд, и прекращает попытки после 100 проверок. Активные состояния: `queued`, `preparing`, `running` и `cancel_requested`. Конечные состояния: `success`, `failed`, `cancelled`, `stopped` и `missed`. Отправляйте в сумме не более 40 запросов наблюдения в минуту и соблюдайте `Retry-After` при ответах 429 или 503.

## 4. Прочитайте результат

```bash
jq '.data | {status:.run.status,hasNodeErrors:.run.hasNodeErrors,
             isolation:.run.isolation,outputs:.result.outputs,error:.result.error}' run-detail.json &&
rpa_curl "$RPA_BASE_URL/runs/$RPA_RUN_ID/nodes?page=1&pageSize=20" -o run-nodes.json &&
rpa_curl "$RPA_BASE_URL/runs/$RPA_RUN_ID/artifacts" -o run-artifacts.json
```

Пример возвращает `outputs.result: "https://example.com/"`. Проверьте `data.run.hasNodeErrors`, `data.run.isolation.state`, а также оба поля `data.result.outputs` и `data.result.error`: запуск может завершиться успешно, даже если некоторые узлы завершились ошибкой и были пропущены.

Записи о выполнении узлов возвращаются постранично. Пока запуск активен, на каждом проходе читайте записи начиная со страницы 1 и объединяйте их по `items[].id`. Когда запуск достигнет конечного состояния, прочитайте все страницы без фильтра по статусу. Эндпоинт артефактов возвращает только метаданные. Прежде чем делиться выводом, скройте в нём конфиденциальные данные.

Отмена является только запросом: продолжайте проверять фактическое конечное состояние и состояние изоляции. Не запускайте шаблон повторно автоматически, если результат не определён или окружение всё ещё находится на карантине. Подробнее см. [Сведения о запуске](/ru/browser-rpa/api/get-run), [Список выполнений узлов](/ru/browser-rpa/api/list-run-nodes) и [Наблюдение за запуском и восстановление запросов](/ru/browser-rpa/api/observation).