# Справочник Local API

Local API RPA для браузера работает в настольном клиенте MoreLogin V2.73.0 или новее и доступен по адресу `http://127.0.0.1:<port>/api/rpa/browser/v1`. Используйте порт Local API, указанный в настройках клиента; по умолчанию это `40000`.

Аутентификация работает так же, как и в остальном Local API; см. [Аутентификация](/ru/api-reference/getting-started/authentication). Отправляйте тела JSON с заголовком `Content-Type: application/json`. Успешный ответ имеет вид `{data,meta}`, а ответ с ошибкой имеет вид `{error,meta}`. Ошибки аутентификации возвращаются в стандартном для Local API формате 401. Обрабатывайте ошибки по статусу HTTP, `error.code`, `details` и путям в замечаниях, а не по тексту сообщения. Полные правила описаны на странице [Соглашения API](/ru/browser-rpa/api/common).

## Перечень эндпоинтов

### Возможности и узлы

| Операция | Метод и относительный путь |
|  --- | --- |
| [Получить возможности](/ru/browser-rpa/api/get-capabilities) | `GET /capabilities` |
| [Список типов узлов](/ru/browser-rpa/api/list-node-types) | `GET /node-types` |
| [Получить контракт узла](/ru/browser-rpa/api/get-node-type) | `GET /node-types/{nodeType}` |


### Проверка сценария

| Операция | Метод и относительный путь |
|  --- | --- |
| [Проверить сценарий](/ru/browser-rpa/api/validate-workflow) | `POST /validations` |


### Шаблоны и редактирование узлов

| Операция | Метод и относительный путь |
|  --- | --- |
| [Список шаблонов](/ru/browser-rpa/api/list-templates) | `GET /templates` |
| [Создать шаблон](/ru/browser-rpa/api/create-template) | `POST /templates` |
| [Получить шаблон](/ru/browser-rpa/api/get-template) | `GET /templates/{templateId}` |
| [Заменить шаблон](/ru/browser-rpa/api/replace-template) | `PUT /templates/{templateId}` |
| [Удалить шаблон](/ru/browser-rpa/api/delete-template) | `DELETE /templates/{templateId}` |
| [Копировать шаблон](/ru/browser-rpa/api/copy-template) | `POST /templates/{templateId}/copies` |
| [Список узлов шаблона](/ru/browser-rpa/api/list-template-nodes) | `GET /templates/{templateId}/nodes` |
| [Изменить узлы шаблона](/ru/browser-rpa/api/edit-template-nodes) | `POST /templates/{templateId}/node-edits` |


### Запуски и результаты

| Операция | Метод и относительный путь |
|  --- | --- |
| [Начать запуск](/ru/browser-rpa/api/start-run) | `POST /runs` |
| [Список запусков](/ru/browser-rpa/api/list-runs) | `GET /runs` |
| [Сведения о запуске](/ru/browser-rpa/api/get-run) | `GET /runs/{runId}` |
| [Отменить запуск](/ru/browser-rpa/api/cancel-run) | `POST /runs/{runId}/cancel` |
| [Список выполнений узлов](/ru/browser-rpa/api/list-run-nodes) | `GET /runs/{runId}/nodes` |
| [Список артефактов запуска](/ru/browser-rpa/api/list-run-artifacts) | `GET /runs/{runId}/artifacts` |


### Восстановление запросов

| Операция | Метод и относительный путь |
|  --- | --- |
| [Получить квитанцию запроса](/ru/browser-rpa/api/get-request-receipt) | `GET /requests/{key}` |


### Общие сведения

- [Соглашения API](/ru/browser-rpa/api/common)
- [Модели данных](/ru/browser-rpa/api/data-types)
- [Сценарий, переменные и структурные узлы](/ru/browser-rpa/api/workflow)
- [Коды ошибок](/ru/browser-rpa/api/error-codes)
- [Сведения об ошибках и матрица восстановления](/ru/browser-rpa/api/recovery)
- [Наблюдение за запуском и восстановление запросов](/ru/browser-rpa/api/observation)


## Обязательные заголовки для запросов на запись

| Операция | `Idempotency-Key` | `X-RPA-Catalog-Revision` | `If-Match` |
|  --- | --- | --- | --- |
| [Создать шаблон](/ru/browser-rpa/api/create-template) | Рекомендуется | Обязателен | — |
| [Заменить шаблон](/ru/browser-rpa/api/replace-template) | Рекомендуется | Обязателен | Обязателен |
| [Удалить шаблон](/ru/browser-rpa/api/delete-template) | Рекомендуется | Не требуется | Обязателен |
| [Копировать шаблон](/ru/browser-rpa/api/copy-template) | Рекомендуется | Обязателен | Обязателен: ETag исходного шаблона |
| [Изменить узлы шаблона](/ru/browser-rpa/api/edit-template-nodes) | Рекомендуется | Обязателен | Обязателен |
| [Начать запуск](/ru/browser-rpa/api/start-run) | Рекомендуется | Обязателен | — |
| [Отменить запуск](/ru/browser-rpa/api/cancel-run) | Рекомендуется | Не требуется | — |


`Idempotency-Key` необязателен, но без него повтор после тайм-аута может привести к повторной записи. Генерируйте новый UUID для каждого нового намерения записи и храните его вместе с методом, путём, телом и `If-Match`, пока не узнаете результат. В `If-Match` передаётся точное значение `ETag`, которое вернула операция [Получить шаблон](/ru/browser-rpa/api/get-template). В `X-RPA-Catalog-Revision` передаётся `data.catalogRevision` из ответа [Получить возможности](/ru/browser-rpa/api/get-capabilities). Операция [Проверить сценарий](/ru/browser-rpa/api/validate-workflow) только читает данные, не требует ни одного из этих заголовков и не оставляет квитанции запроса.

## Локальный машиночитаемый контракт

Чтобы получить HTTP-контракт, прочитайте `/openapi.json` по локальному базовому URL. URL схемы сценария указан в `data.docs.schema` ответа `GET /capabilities`.

## Изменение существующего шаблона

Прочитайте последнюю версию шаблона и контракты узлов, которые собираетесь изменить. Для точечных изменений примените предлагаемые правки узлов ко всему дереву и проверьте результат с `purpose:"save"`, `source.kind:"inline"` и `source.base:{templateId,version}`. Когда кандидат пройдёт проверку, отправьте операции через `node-edits`. Пакет правок либо сохраняет одну новую версию, либо ничего не меняет. При замене узлов и блоков отправляйте их целиком, а при удалении узлов исправляйте ссылки на них. Чтобы заменить шаблон целиком, используйте PUT. Указывайте зависимости от дочерних шаблонов в виде их текущих `{processId,revisionId}`, а после конфликта версий прочитайте зависимости заново.

## Восстановление

| Ситуация | Следующий шаг |
|  --- | --- |
| Тайм-аут записи, потеря соединения или неизвестный результат | Запросите `GET /requests/{originalKey}`. При `completed` используйте исходный результат; после завершённой регистрации запуска всё равно нужно проверить статус запуска. Состояния `accepted` и `committed` опрашивайте в течение ограниченного времени. При `unknown`, обычном ответе 404 или истёкшей квитанции прекратите автоматическую запись и проверьте ресурс. |
| `RPA_REQUEST_NOT_COMMITTED` с `safeToRetrySameKey=true` | Повторите то же намерение с исходными ключом, методом, путём, телом и `If-Match`, если он передавался. |
| Конфликт версий 412 | Сначала проверьте квитанцию. Убедившись, что запись не была зафиксирована, снова прочитайте шаблон, объедините изменения, выполните проверку и отправьте запрос с новым ключом и текущим ETag. |
| Каталог изменился | Проверьте квитанцию и убедитесь, что запись не была зафиксирована, затем обновите возможности и контракты. Если тело и `If-Match` не меняются, обновите заголовок каталога и оставьте исходный ключ. |
| `valid=false` или детерминированная ошибка входных данных | Исправьте указанный путь и повторите проверку. Если запись зарегистрирована как неудачная, убедитесь, что ничего не было зафиксировано, прежде чем использовать новый ключ. При 429 или 503 соблюдайте `Retry-After` и правила для квитанций. |


Чтобы запустить сохранённый шаблон, см. [Запуск шаблона через API](/ru/browser-rpa/run-api-example).