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

Продовжуйте в тому самому сеансі Bash і робочому каталозі, що й у [швидкому старті](/uk/browser-rpa/quickstart). Спочатку переконайтеся, що клієнт підтримує операції, які використовує ця сторінка:

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

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

## 1. Виконайте попередню перевірку збереженої версії

Для попередньої перевірки та запуску використовуйте однакові ідентифікатор шаблону, версію, середовище й параметри. Передавайте кожне значення параметра у форматі `{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 означає, що запуск зареєстровано, але ще не завершено. Збережіть ідентифікатор запуску, початковий ключ і заморожену ревізію шаблону. Тайм-аут на транспортному рівні не скасовує запуск: перш ніж надсилати інший запит на запис, скористайтеся [відновленням запитів](/uk/browser-rpa/local-api#%D0%B2%D1%96%D0%B4%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F).

## 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`. Коли запуск досягне кінцевого стану, прочитайте всі сторінки без фільтра за статусом. Ендпоінт артефактів повертає лише метадані. Перш ніж ділитися вихідними даними, приховайте в них конфіденційну інформацію.

Скасування є запитом: продовжуйте перевіряти фактичний кінцевий стан і стан ізоляції. Не перезапускайте автоматично, якщо результат невизначений або середовище досі в карантині. Докладніше див. [Відомості про запуск](/uk/browser-rpa/api/get-run), [Список виконань вузлів](/uk/browser-rpa/api/list-run-nodes) і [Спостереження за запуском і відновлення запитів](/uk/browser-rpa/api/observation).