Перейти к содержимому
Last updated

Быстрый старт: создание шаблона

В этом примере сохраняется шаблон, который открывает URL, переданный при запуске, и возвращает итоговый адрес с учётом перенаправлений. Выполняйте фрагменты по порядку в одном сеансе Bash в macOS или Linux; в Windows используйте WSL. Понадобятся настольный клиент MoreLogin V2.73.0 или новее, curl 7.76 или новее, jq и uuidgen. Не удаляйте созданные файлы: они нужны для примера запуска и восстановления запросов.

1. Запросите возможности и контракты

Укажите порт Local API, который показан в клиенте MoreLogin. Команды выполняются в закрытом временном каталоге, потому что реальные ответы с шаблонами и запусками могут содержать конфиденциальные значения.

umask 077
RPA_BASE_URL='http://127.0.0.1:40000/api/rpa/browser/v1'
RPA_DIR="$(mktemp -d)" && cd "$RPA_DIR"
rpa_curl() {
  curl --fail-with-body -sS --max-time 30 "$@"
}

Если вы включили аутентификацию Local API, добавьте в команду curl внутри rpa_curl заголовок Authorization, описанный в разделе Аутентификация.

Убедитесь, что клиент поддерживает операции из этого примера, и запишите ревизию каталога. Запросы на запись передают её обратно в заголовке X-RPA-Catalog-Revision.

rpa_curl "$RPA_BASE_URL/capabilities" -o capabilities.json &&
jq '.data | {operations, limits, docs}' capabilities.json &&
jq -e '.data.operations as $ops | ["listNodeTypes","getNodeType","validateWorkflow","createTemplate"] - $ops | length == 0' capabilities.json &&
RPA_CATALOG_REVISION="$(jq -er '.data.catalogRevision' capabilities.json)"

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

rpa_curl --get "$RPA_BASE_URL/node-types" --data-urlencode 'q=gotoUrl' -o node-types.json &&
rpa_curl "$RPA_BASE_URL/node-types/start" -o start.contract.json &&
rpa_curl "$RPA_BASE_URL/node-types/end" -o end.contract.json &&
rpa_curl "$RPA_BASE_URL/node-types/browser_gotoUrl" -o browser_gotoUrl.contract.json &&
rpa_curl "$RPA_BASE_URL/node-types/browser_getUrl" -o browser_getUrl.contract.json &&
jq -s -e 'all(.[]; .data | .authorable and .runtimeSupported and .externalRunnable and .documentationComplete)' *.contract.json

AI-агенты могут начать с локальных руководств: rpa_curl "$RPA_BASE_URL/llms.txt" выводит ссылки на Skill (/docs/SKILL.md) и руководство по API. Пути, которые начинаются с /, разрешаются относительно http://127.0.0.1:<port>.

2. Проверьте шаблон-кандидат целиком

Сохраните следующее тело запроса в файл create.json. Дайте каждому узлу название, которое описывает, что он делает. Узел end возвращает свой message как outputs.result запуска; здесь сообщение берётся из выходного значения data.value узла url_result.

{
  "title": "Return the final page URL",
  "description": "Visit the supplied page and return its final URL",
  "workflow": {
    "editorVersion": 2,
    "editorParametersVersion": 1,
    "variables": {
      "type": "object",
      "properties": {
        "targetUrl": {
          "type": "string",
          "description": "Absolute HTTP(S) URL to open"
        }
      },
      "required": [
        "targetUrl"
      ]
    },
    "nodes": [
      {
        "id": "start",
        "type": "start",
        "data": {
          "title": "Read the target URL parameter"
        }
      },
      {
        "id": "visit",
        "type": "browser_gotoUrl",
        "data": {
          "browserAction": "gotoUrl",
          "browserUi": {
            "inputs": {
              "url": "${targetUrl}",
              "postWaitMs": 0
            },
            "exception": {
              "timeout": 30000,
              "policy": "interrupt"
            }
          },
          "title": "Open the supplied page"
        }
      },
      {
        "id": "url_result",
        "type": "browser_getUrl",
        "data": {
          "browserAction": "getUrl",
          "browserUi": {
            "inputs": {
              "type": "href"
            },
            "exception": {
              "timeout": 30000,
              "policy": "interrupt"
            }
          },
          "title": "Read the final URL after navigation"
        }
      },
      {
        "id": "end",
        "type": "end",
        "data": {
          "inputsValues": {
            "status": {
              "type": "constant",
              "content": "success"
            },
            "message": {
              "type": "ref",
              "content": [
                "url_result",
                "data",
                "value"
              ]
            }
          },
          "title": "Report the final page URL"
        }
      }
    ]
  },
  "dependencies": []
}
jq '{purpose:"save",source:{kind:"inline",template:.}}' create.json > validate-save.json &&
rpa_curl "$RPA_BASE_URL/validations" -H 'Content-Type: application/json' \
  --data-binary @validate-save.json -o validation-save.json &&
jq '.data | {valid,issues,truncated,runtimeChecks}' validation-save.json &&
jq -e '.data.valid == true and .data.truncated == false' validation-save.json

Изучите отчёт о проверке, включая предупреждения и проверки времени выполнения. Продолжайте, только если valid равно true и отчёт не усечён. Проверка не открывает браузер.

3. Сохраните шаблон и запишите версию

([ -s create.key ] || uuidgen > create.key) &&
rpa_curl "$RPA_BASE_URL/templates" -H 'Content-Type: application/json' \
  -H "X-RPA-Catalog-Revision: $RPA_CATALOG_REVISION" \
  -H "Idempotency-Key: $(cat create.key)" \
  --data-binary @create.json -D created.headers -o created.json &&
head -n 1 created.headers &&
jq '.data | {id,version,revisionId,warnings}' created.json

HTTP 201 означает, что шаблон сохранён. Сохраните нормализованный ответ, в котором есть сценарий, ID, версия и ID ревизии, а также ETag из created.headers. Ключ в create.key идентифицирует это намерение записи: используйте его снова только при повторе того же запроса, а для новой записи генерируйте новый ключ. Если запрос завершится по тайм-ауту, выполните восстановление запроса, прежде чем отправлять новый запрос на запись.

После обновления списка шаблонов шаблон также появится в разделе Пользовательские шаблоны настольного клиента. Чтобы изменить его позже, прочитайте последнюю версию, проверьте полный шаблон-кандидат с source.base и отправьте правку с текущим If-Match. См. Изменение существующего шаблона.

Далее: запустите сохранённый шаблон через API.