# Довідник Local API

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

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

## Перелік ендпоінтів

### Можливості та вузли

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


### Перевірка сценарію

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


### Шаблони та редагування вузлів

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


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

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


### Відновлення запитів

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


### Спільні відомості

- [Угоди API](/uk/browser-rpa/api/common)
- [Моделі даних](/uk/browser-rpa/api/data-types)
- [Сценарій, змінні та структурні вузли](/uk/browser-rpa/api/workflow)
- [Коди помилок](/uk/browser-rpa/api/error-codes)
- [Відомості про помилки та матриця відновлення](/uk/browser-rpa/api/recovery)
- [Спостереження за запуском і відновлення запитів](/uk/browser-rpa/api/observation)


## Обов'язкові заголовки для запитів на запис

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


`Idempotency-Key` необов'язковий, але без нього повтор після тайм-ауту може виконати запис ще раз. Генеруйте новий UUID для кожного нового наміру запису й зберігайте його разом із методом, шляхом, тілом запиту та `If-Match`, доки не дізнаєтеся результат. У `If-Match` передайте точне значення `ETag`, яке повернула операція [Отримати шаблон](/uk/browser-rpa/api/get-template). У `X-RPA-Catalog-Revision` передайте `data.catalogRevision` з відповіді операції [Отримати можливості](/uk/browser-rpa/api/get-capabilities). Операція [Перевірити сценарій](/uk/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](/uk/browser-rpa/run-api-example).